Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

T264: IPsec add base64 encoded secret-type feature #4198

Merged
merged 1 commit into from
Nov 26, 2024
Merged

T264: IPsec add base64 encoded secret-type feature #4198

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions data/templates/ipsec/swanctl.conf.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,11 @@ secrets {
id-{{ gen_uuid }} = "{{ id }}"
{% endfor %}
{% endif %}
{% if psk_config.secret_type is vyos_defined('base64') %}
secret = 0s{{ psk_config.secret }}
{% elif psk_config.secret_type is vyos_defined('plaintext') %}
secret = "{{ psk_config.secret }}"
{% endif %}
}
{% endfor %}
{% endif %}
Expand Down
12 changes: 12 additions & 0 deletions interface-definitions/vpn_ipsec.xml.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,18 @@
</valueHelp>
</properties>
</leafNode>
<leafNode name="secret-type">
<properties>
<help>Secret type</help>
<completionHelp>
<list>base64 plaintext</list>
</completionHelp>
<constraint>
<regex>(base64|plaintext)</regex>
</constraint>
</properties>
<defaultValue>plaintext</defaultValue>
</leafNode>
</children>
</tagNode>
</children>
Expand Down
26 changes: 26 additions & 0 deletions python/vyos/utils/convert.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -235,3 +235,29 @@ def convert_data(data) -> dict | list | tuple | str | int | float | bool | None:
# which cannot be converted to JSON
# for example: complex | range | memoryview
return


def encode_to_base64(input_string):
"""
Encodes a given string to its base64 representation.

Args:
input_string (str): The string to be encoded.

Returns:
str: The base64-encoded version of the input string.

Example:
input_string = "Hello, World!"
encoded_string = encode_to_base64(input_string)
print(encoded_string) # Output: SGVsbG8sIFdvcmxkIQ==
"""
import base64
# Convert the string to bytes
byte_string = input_string.encode('utf-8')

# Encode the byte string to base64
encoded_string = base64.b64encode(byte_string)

# Decode the base64 bytes back to a string
return encoded_string.decode('utf-8')
7 changes: 5 additions & 2 deletions smoketest/scripts/cli/test_vpn_ipsec.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@

from vyos.configsession import ConfigSessionError
from vyos.ifconfig import Interface
from vyos.utils.convert import encode_to_base64
from vyos.utils.process import process_named_running
from vyos.utils.file import read_file

Expand Down Expand Up @@ -495,6 +496,7 @@ def test_flex_vpn_vips(self):
local_id = 'vyos-r1'
remote_id = 'vyos-r2'
peer_base_path = base_path + ['site-to-site', 'peer', connection_name]
secret_base64 = encode_to_base64(secret)

self.cli_set(tunnel_path + ['tun1', 'encapsulation', 'gre'])
self.cli_set(tunnel_path + ['tun1', 'source-address', local_address])
Expand All @@ -509,7 +511,8 @@ def test_flex_vpn_vips(self):
self.cli_set(base_path + ['authentication', 'psk', connection_name, 'id', remote_id])
self.cli_set(base_path + ['authentication', 'psk', connection_name, 'id', local_address])
self.cli_set(base_path + ['authentication', 'psk', connection_name, 'id', peer_ip])
self.cli_set(base_path + ['authentication', 'psk', connection_name, 'secret', secret])
self.cli_set(base_path + ['authentication', 'psk', connection_name, 'secret', secret_base64])
self.cli_set(base_path + ['authentication', 'psk', connection_name, 'secret-type', 'base64'])

self.cli_set(peer_base_path + ['authentication', 'local-id', local_id])
self.cli_set(peer_base_path + ['authentication', 'mode', 'pre-shared-secret'])
Expand Down Expand Up @@ -546,7 +549,7 @@ def test_flex_vpn_vips(self):
f'id-{regex_uuid4} = "{remote_id}"',
f'id-{regex_uuid4} = "{peer_ip}"',
f'id-{regex_uuid4} = "{local_address}"',
f'secret = "{secret}"',
f'secret = 0s{secret_base64}',
]

for line in swanctl_secrets_lines:
Expand Down
Loading