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

Expose new libssh option publickey_accepted_algorithms #597

Merged
merged 3 commits into from
Oct 31, 2024
Merged

Expose new libssh option publickey_accepted_algorithms #597

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7adec7c
Expose new libssh option publickey_accepted_algorithms
Qalthos Oct 27, 2023
e3a792c
Expose preferred hostkeys option
NilashishC Oct 30, 2023
27f9135
Add changelog
NilashishC Oct 31, 2024
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
3 changes: 3 additions & 0 deletions changelogs/fragments/libssh_pubkey_algo.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
minor_changes:
- "Exposes new libssh options to configure publickey_accepted_algorithms and hostkeys. This requires ansible-pylibssh v1.1.0 or higher."
46 changes: 46 additions & 0 deletions docs/ansible.netcommon.libssh_connection.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,29 @@ Parameters
<div>Set this to &quot;False&quot; if you want to avoid host key checking by the underlying tools Ansible uses to connect to the host</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div>
<b>hostkeys</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
<b>Default:</b><br/><div style="color: blue">""</div>
</td>
<td>
<div> ini entries:
<p>[libssh_connection]<br>hostkeys = </p>
</div>
<div>env:ANSIBLE_LIBSSH_HOSTKEYS</div>
<div>var: ansible_libssh_hostkeys</div>
</td>
<td>
<div>Set the preferred server host key types as a comma-separated list (e.g., ssh-rsa,ssh-dss,ecdh-sha2-nistp256).</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div>
Expand Down Expand Up @@ -220,6 +243,29 @@ Parameters
<div>TODO: write it</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div>
<b>publickey_accepted_algorithms</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
<b>Default:</b><br/><div style="color: blue">""</div>
</td>
<td>
<div> ini entries:
<p>[libssh_connection]<br>publickey_algorithms = </p>
</div>
<div>env:ANSIBLE_LIBSSH_PUBLICKEY_ALGORITHMS</div>
<div>var: ansible_libssh_publickey_algorithms</div>
</td>
<td>
<div>List of algorithms to forward to SSH_OPTIONS_PUBLICKEY_ACCEPTED_TYPES.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div>
Expand Down
29 changes: 29 additions & 0 deletions plugins/connection/libssh.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,27 @@
- section: libssh_connection
key: pty
type: boolean
publickey_accepted_algorithms:
default: ''
description:
- List of algorithms to forward to SSH_OPTIONS_PUBLICKEY_ACCEPTED_TYPES.
type: string
env:
- name: ANSIBLE_LIBSSH_PUBLICKEY_ALGORITHMS
ini:
- {key: publickey_algorithms, section: libssh_connection}
vars:
- name: ansible_libssh_publickey_algorithms
hostkeys:
default: ''
description: Set the preferred server host key types as a comma-separated list (e.g., ssh-rsa,ssh-dss,ecdh-sha2-nistp256).
type: string
env:
- name: ANSIBLE_LIBSSH_HOSTKEYS
ini:
- {key: hostkeys, section: libssh_connection}
vars:
- name: ansible_libssh_hostkeys
host_key_checking:
description: 'Set this to "False" if you want to avoid host key checking by the underlying tools Ansible uses to connect to the host'
type: boolean
Expand Down Expand Up @@ -401,6 +422,14 @@ def _connect_uncached(self):
"Please upgrade to ansible-pylibssh 1.0.0 or newer." % PYLIBSSH_VERSION
)

if self.get_option("publickey_accepted_algorithms"):
ssh_connect_kwargs["publickey_accepted_algorithms"] = self.get_option(
"publickey_accepted_algorithms"
)

if self.get_option("hostkeys"):
ssh_connect_kwargs["hostkeys"] = self.get_option("hostkeys")

self.ssh.set_missing_host_key_policy(MyAddPolicy(self._new_stdin, self))

self.ssh.connect(
Expand Down
Loading