Documentation/netlink/specs/ovpn.yaml

Source file repositories/reference/linux-study-clean/Documentation/netlink/specs/ovpn.yaml

File Facts

System: Linux kernel
Corpus path: Documentation/netlink/specs/ovpn.yaml
Extension: .yaml
Size: 12123 bytes
Lines: 530
Domain: Support Tooling And Documentation
Bucket: Documentation
Inferred role: Support Tooling And Documentation: configuration, schema, or hardware description
Status: atlas-only

Why This File Exists

Repository support layer: documentation, build tooling, samples, user-space helper tools, generated initramfs support, licenses, and validation utilities.

Repository support layer: documentation, build tooling, samples, user-space helper tools, generated initramfs support, licenses, and validation utilities.

Dependency Surface

No C-style include directives detected by the generator.

Detected Declarations

No top-level syscall, struct, function, initcall, or export declaration detected by the generator.

Annotated Snippet

# SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Clause)
#
# Author: Antonio Quartulli <antonio@openvpn.net>
#
# Copyright (c) 2024-2025, OpenVPN Inc.
#
---
name: ovpn

protocol: genetlink

doc: Netlink protocol to control OpenVPN network devices

definitions:
  -
    type: const
    name: nonce-tail-size
    value: 8
  -
    type: enum
    name: cipher-alg
    entries: [none, aes-gcm, chacha20-poly1305]
  -
    type: enum
    name: del-peer-reason
    entries:
      - teardown
      - userspace
      - expired
      - transport-error
      - transport-disconnect
  -
    type: enum
    name: key-slot
    entries: [primary, secondary]

attribute-sets:
  -
    name: peer
    attributes:
      -
        name: id
        type: u32
        doc: >-
          The unique ID of the peer in the device context. To be used to
          identify peers during operations for a specific device.
          Also used to match packets received from this peer.
        checks:
          max: 0xFFFFFF
      -
        name: remote-ipv4
        type: u32
        doc: The remote IPv4 address of the peer
        byte-order: big-endian
        display-hint: ipv4
      -
        name: remote-ipv6
        type: binary
        doc: The remote IPv6 address of the peer
        display-hint: ipv6
        checks:
          exact-len: 16
      -
        name: remote-ipv6-scope-id
        type: u32
        doc: The scope id of the remote IPv6 address of the peer (RFC2553)
      -
        name: remote-port
        type: u16
        doc: The remote port of the peer

Annotation

Atlas domain: Support Tooling And Documentation / Documentation.
Implementation status: atlas-only.

Implementation Notes

This generated page is the file-by-file coverage layer; curated subsystem chapters should link here when they synthesize a multi-file control flow.
Core OS pages should be promoted from atlas-only to deep-reviewed when they explain data structures, invariants, locking, lifecycle, and C implementation snippets.
Driver-family pages are intentionally pattern-oriented unless they are part of the selected PCIe/NVMe representative device path.