Skip to content

Conversation

@giga1699
Copy link
Contributor

@giga1699 giga1699 commented Jan 3, 2026

Change Summary

Provides information on use of post-quantum preshared keys (PPK)

Related Task(s)

Related PR(s)

vyos/vyos-1x#4930

Backport

Checklist:

tunnels when a Post-Quantum key exchange algorithm such as ML-KEM is not
available. The use of PPKs in IKEv2 is described in :rfc:`8784`.

PPKs can be configued within VyOS under the vpn.ipsec.authentication.ppk
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
PPKs can be configued within VyOS under the vpn.ipsec.authentication.ppk
PPKs can be configued within VyOS under the `vpn ipsec authentication ppk`

In my opinion it will be better this way.

Comment on lines +119 to +144
PPKs can be configued within VyOS under the vpn.ipsec.authentication.ppk
config.

.. cfgmod:: edit vpn authentication ppk <name>

PPKs need an id and a secret value. The ID and secret must match if PPKs are
required for a successful IPSEC connection. The secret can be plain text, a
hex value, or a base64 value. The default is plain text. If using another
type of value, you must define the secret-type.

.. cfgmod:: set vpn authentication ppk <name> secret-type <plaintext|hex|base64>

To use a PPK within a site-to-site or remote-access connection, define the PPK
id under the connection.

.. cfgmod:: set vpn ipsec site-to-site <name> ppk id <id>

Optionally, you can require the use of PPK to have a successful connection.

.. cfgmod:: set vpn ipsec site-to-site <name> ppk required

To confirm the use of a PPK in an IKE SA, check for the presence of "up-ppk" in
the output of the show command under the status heading. If you only see "up", or
"down", PPK is not in use.

.. cfgmod:: show vpn ike sa
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
PPKs can be configued within VyOS under the vpn.ipsec.authentication.ppk
config.
.. cfgmod:: edit vpn authentication ppk <name>
PPKs need an id and a secret value. The ID and secret must match if PPKs are
required for a successful IPSEC connection. The secret can be plain text, a
hex value, or a base64 value. The default is plain text. If using another
type of value, you must define the secret-type.
.. cfgmod:: set vpn authentication ppk <name> secret-type <plaintext|hex|base64>
To use a PPK within a site-to-site or remote-access connection, define the PPK
id under the connection.
.. cfgmod:: set vpn ipsec site-to-site <name> ppk id <id>
Optionally, you can require the use of PPK to have a successful connection.
.. cfgmod:: set vpn ipsec site-to-site <name> ppk required
To confirm the use of a PPK in an IKE SA, check for the presence of "up-ppk" in
the output of the show command under the status heading. If you only see "up", or
"down", PPK is not in use.
.. cfgmod:: show vpn ike sa
.. cfgmod:: edit vpn authentication ppk <name>
PPKs can be configued within VyOS under the `vpn ipsec authentication ppk`
config.
.. cfgmod:: set vpn authentication ppk <name> secret-type <plaintext|hex|base64>
PPKs need an id and a secret value. The ID and secret must match if PPKs are
required for a successful IPSEC connection. The secret can be plain text, a
hex value, or a base64 value. The default is plain text. If using another
type of value, you must define the secret-type.
.. cfgmod:: set vpn ipsec site-to-site <name> ppk id <id>
To use a PPK within a site-to-site or remote-access connection, define the PPK
id under the connection.
.. cfgmod:: set vpn ipsec site-to-site <name> ppk required
Optionally, you can require the use of PPK to have a successful connection.
.. cfgmod:: show vpn ike sa
To confirm the use of a PPK in an IKE SA, check for the presence of "up-ppk" in
the output of the show command under the status heading. If you only see "up", or
"down", PPK is not in use.

As I see on other pages, the command description should be after the command (not before).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants