HEX

File: //usr/lib/python3/dist-packages/cloudinit/config/__pycache__/cc_ssh.cpython-310.pyc
o

�Ad#8�@s�UdZddlZddlZddlZddlZddlmZddlmZddl	m
Z
mZmZddl
mZmZmZddlmZddlmZdd	lmZmZdd
lmZmZddlmZdZd
ddeegeed�ggd�Zeed<ee�Zgd�Z e�!d�Z"dZ#dZ$dgZ%iZ&iZ'e D]2Z(e&�)e(�d�e#e(dfe(�d�e#e(�d�dfe(�d�e#e(�d�dfi�e(�d�e'e(�d�<q�dZ*d e+d!ed"ed#ed$e,d%dfd&d'�Z-d(d)�Z.d-d*eee+fd+d,�Z/dS).zSSH: Configure SSH and SSH keys�N)�Logger)�dedent)�List�Optional�Sequence)�ssh_util�subp�util)�Cloud)�Config)�
MetaSchema�get_meta_doc)�ALL_DISTROS�ug_util)�PER_INSTANCEa�This module handles most configuration for SSH and both host and authorized SSH
keys.

Authorized Keys
^^^^^^^^^^^^^^^

Authorized keys are a list of public SSH keys that are allowed to connect to
a user account on a system. They are stored in `.ssh/authorized_keys` in that
account's home directory. Authorized keys for the default user defined in
``users`` can be specified using ``ssh_authorized_keys``. Keys
should be specified as a list of public keys.

.. note::
    see the ``cc_set_passwords`` module documentation to enable/disable SSH
    password authentication

Root login can be enabled/disabled using the ``disable_root`` config key. Root
login options can be manually specified with ``disable_root_opts``.

Supported public key types for the ``ssh_authorized_keys`` are:

    - dsa
    - rsa
    - ecdsa
    - ed25519
    - ecdsa-sha2-nistp256-cert-v01@openssh.com
    - ecdsa-sha2-nistp256
    - ecdsa-sha2-nistp384-cert-v01@openssh.com
    - ecdsa-sha2-nistp384
    - ecdsa-sha2-nistp521-cert-v01@openssh.com
    - ecdsa-sha2-nistp521
    - sk-ecdsa-sha2-nistp256-cert-v01@openssh.com
    - sk-ecdsa-sha2-nistp256@openssh.com
    - sk-ssh-ed25519-cert-v01@openssh.com
    - sk-ssh-ed25519@openssh.com
    - ssh-dss-cert-v01@openssh.com
    - ssh-dss
    - ssh-ed25519-cert-v01@openssh.com
    - ssh-ed25519
    - ssh-rsa-cert-v01@openssh.com
    - ssh-rsa
    - ssh-xmss-cert-v01@openssh.com
    - ssh-xmss@openssh.com

.. note::
    this list has been filtered out from the supported keytypes of
    `OpenSSH`_ source, where the sigonly keys are removed. Please see
    ``ssh_util`` for more information.

    ``dsa``, ``rsa``, ``ecdsa`` and ``ed25519`` are added for legacy,
    as they are valid public keys in some old distros. They can possibly
    be removed in the future when support for the older distros are dropped

.. _OpenSSH: https://github.com/openssh/openssh-portable/blob/master/sshkey.c

Host Keys
^^^^^^^^^

Host keys are for authenticating a specific instance. Many images have default
host SSH keys, which can be removed using ``ssh_deletekeys``.

Host keys can be added using the ``ssh_keys`` configuration key.

When host keys are generated the output of the ssh-keygen command(s) can be
displayed on the console using the ``ssh_quiet_keygen`` configuration key.

.. note::
    when specifying private host keys in cloud-config, care should be taken to
    ensure that the communication between the data source and the instance is
    secure


If no host keys are specified using ``ssh_keys``, then keys will be generated
using ``ssh-keygen``. By default one public/private pair of each supported
host key type will be generated. The key types to generate can be specified
using the ``ssh_genkeytypes`` config flag, which accepts a list of host key
types to use. For each host key type for which this module has been instructed
to create a keypair, if a key of the same type is already present on the
system (i.e. if ``ssh_deletekeys`` was false), no key will be generated.

Supported host key types for the ``ssh_keys`` and the ``ssh_genkeytypes``
config flags are:

    - dsa
    - ecdsa
    - ed25519
    - rsa

Unsupported host key types for the ``ssh_keys`` and the ``ssh_genkeytypes``
config flags are:

    - ecdsa-sk
    - ed25519-sk
�cc_ssh�SSHzConfigure SSH and SSH keysa�            ssh_keys:
              rsa_private: |
                -----BEGIN RSA PRIVATE KEY-----
                MIIBxwIBAAJhAKD0YSHy73nUgysO13XsJmd4fHiFyQ+00R7VVu2iV9Qco
                ...
                -----END RSA PRIVATE KEY-----
              rsa_public: ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAGEAoPRhIfLvedSDKw7Xd ...
              rsa_certificate: |
                ssh-rsa-cert-v01@openssh.com AAAAIHNzaC1lZDI1NTE5LWNlcnQt ...
              dsa_private: |
                -----BEGIN DSA PRIVATE KEY-----
                MIIBxwIBAAJhAKD0YSHy73nUgysO13XsJmd4fHiFyQ+00R7VVu2iV9Qco
                ...
                -----END DSA PRIVATE KEY-----
              dsa_public: ssh-dsa AAAAB3NzaC1yc2EAAAABIwAAAGEAoPRhIfLvedSDKw7Xd ...
              dsa_certificate: |
                ssh-dsa-cert-v01@openssh.com AAAAIHNzaC1lZDI1NTE5LWNlcnQt ...
            ssh_authorized_keys:
              - ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAGEA3FSyQwBI6Z+nCSjUU ...
              - ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEA3I7VUf2l5gSn5uavROsc5HRDpZ ...
            ssh_deletekeys: true
            ssh_genkeytypes: [rsa, dsa, ecdsa, ed25519]
            disable_root: true
            disable_root_opts: no-port-forwarding,no-agent-forwarding,no-X11-forwarding
            allow_public_ssh_keys: true
            ssh_quiet_keygen: true
            ssh_publish_hostkeys:
              enabled: true
              blacklist: [dsa]
            )�id�name�title�description�distros�	frequency�examples�activate_by_schema_keys�meta)�rsa�dsa�ecdsa�ed25519z4^(ecdsa-sk|ed25519-sk)_(private|public|certificate)$z/etc/ssh/ssh_host_%s_keyTr�_privatei��_public�.pub��_certificatez	-cert.pubz;o=$(ssh-keygen -yf "%s") && echo "$o" root@localhost > "%s"r�cfg�cloud�log�args�returnc%Cs�|�dd�r,tj�dd�}t�|�D]}zt�|�Wqty+t�|d|�Yqwd|vr�g}|d�	�D]:\}}	|t
vrRt�|�rHd}
nd}
|�
d	|
|�q8t
|d
}t
|d}t�||	|�d|vrr|�d
t|�f�q8|rzt�|�t�	�D]g\}
}||dvs�|
|dvr�q~t
|
d
t
|d
}}ddt||fg}z+tjddd��tj|dd�Wd�n1s�wY|�d|�d|���Wq~ty�t�|d|�d|���Yq~wn�t�|dt�}tj��}d|d<|D]�}t|}tj�|��rq�t�tj�|��dd|ddd|g}tjddd��~z<tj|d|d�\}}t� |d d��s=t!j"�#t�$|��t�%d�}|d!k�r\t�&|d!|�t�'|d"�t�'|d#d$�Wn9tj(�y�}z+t�$|j)��*�}|j+dk�r�|�*��,d%��r�|�d&|�nt�|d'||�WYd}~nd}~wwWd�n	1�s�wYq�d(|v�r�t�|d(d)t-�}t� |d(d*t.�}nt-}t.}|�r�t/|d+�}z|j0�1|�Wnt�y�t�|d,�YnwzNt2�3||j4�\}}t2�5|�\}} t� |d-d�}!t�6|d.tj7�}"g}#t� |d/d��r|�8��pg}#n|�d0�d1|v�r*|d1}$|#�9|$�t:|#||!|"�WdSt�yDt�|d2�YdSw)3N�ssh_deletekeysTz	/etc/ssh/zssh_host_*key*zFailed deleting key file %s�ssh_keys�unsupported�unrecognizedz Skipping %s ssh_keys entry: "%s"r�r$�HostCertificate�shz-xcz/etc/ssh)�	recursiveF)�capturezGenerated a key for z from zFailed generating a key for �ssh_genkeytypes�C�LANGz
ssh-keygenz-tz-N�z-f)r2�env�ssh_quiet_keygen���i�r"r#zunknown keyz!ssh-keygen: unknown key type '%s'z(Failed generating key type %s to file %s�ssh_publish_hostkeys�	blacklist�enabled)r;zPublishing host keys failed!�disable_root�disable_root_opts�allow_public_ssh_keyszSSkipping import of publish SSH keys per config setting: allow_public_ssh_keys=False�ssh_authorized_keysz Applying SSH credentials failed!);�get�os�path�join�globr	�del_file�	Exception�logexc�items�CONFIG_KEY_TO_FILE�pattern_unsupported_config_keys�match�warning�
write_file�append�strr�append_ssh_config�PRIV_TO_PUB�KEY_GEN_TPL�SeLinuxGuardr�debug�get_cfg_option_list�GENERATE_KEY_NAMES�environ�copy�KEY_FILE_TPL�exists�
ensure_dir�dirname�get_cfg_option_bool�sys�stdout�write�
decode_binary�get_group_id�chown�chmod�ProcessExecutionError�stderr�lower�	exit_code�
startswith�HOST_KEY_PUBLISH_BLACKLIST�PUBLISH_HOST_KEYS�get_public_host_keys�
datasource�publish_host_keysr�normalize_users_groups�distro�extract_default�get_cfg_option_str�DISABLE_USER_OPTS�get_public_ssh_keys�extend�apply_credentials)%rr%r&r'r(�key_pth�f�cert_config�key�val�reason�tgt_fn�	tgt_perms�private_type�public_type�private_file�public_file�cmd�genkeys�lang_c�keytype�keyfile�out�err�gid�e�host_key_blacklist�publish_hostkeys�hostkeys�users�_groups�user�_user_configr=r>�keys�cfgkeys�r��9/usr/lib/python3/dist-packages/cloudinit/config/cc_ssh.py�handle�s�
�

�
�

���������
�

��������
�
�
���

�r�cCsVt|�}|rt�||�|r|sd}|�d|�}|�dd�}nd}tj|d|d�dS)N�NONEz$USERz
$DISABLE_USER�rootr6)�options)�setr�setup_user_keys�replace)r�r�r=r>�
key_prefixr�r�r�rwZsrwr;cs�dtf�g}g�|r�fdd�|D���fdd�t��d�D�}|D]}t�|�}|��}|rBt|�dkrB|�t|dd���q$|S)	aRead host keys from /etc/ssh/*.pub files and return them as a list.

    @param blacklist: List of key types to ignore. e.g. ['dsa', 'rsa']
    @returns: List of keys, each formatted as a two-element tuple.
        e.g. [('ssh-rsa', 'AAAAB3Nz...'), ('ssh-ed25519', 'AAAAC3Nx...')]
    z%s.pubcsg|]}�|f�qSr�r�)�.0�key_type)�public_key_file_tmplr�r��
<listcomp>xs
�z(get_public_host_keys.<locals>.<listcomp>csg|]}|�vr|�qSr�r�)r��hostfile)�blacklist_filesr�r�r�|s��)�*r.N�)rZrEr	�	load_file�split�lenrO�tuple)r;�key_list�	file_list�	file_name�
file_contents�key_datar�)r�r�r�rmks"

�
�
�rm)N)0�__doc__rErB�rer_�loggingr�textwrapr�typingrrr�	cloudinitrrr	�cloudinit.cloudr
�cloudinit.configr�cloudinit.config.schemarr
�cloudinit.distrosrr�cloudinit.settingsr�MODULE_DESCRIPTIONr�__annotations__rW�compilerKrZrlrkrJrR�k�updaterSrP�listr�rwrmr�r�r�r��<module>s|g��#�-��������
�