3
\�mep; � @ s� U d Z ddlZddlZddlZddlZddlZddlmZ ddlm Z m
Z
m Z ddl m
Z
mZmZ ddlmZ ddlmZ ddlmZmZ dd lmZmZ dd
lmZ d Z d d
de egeed�gg d�Z e ee �Z ej e �Z ddddgZ!ddgZ"ej#d�Z$dZ%dZ&dgZ'i Z(i Z)xne!D ]fZ*e(j+e*� d�e%e* dfe*� d�e%e* � d�d fe*� d �e%e* � d �d fi� e*� d�e)e*� d�< �qW d Z,e-eee.dd �d!d"�Z/d#d$� Z0d(e
e e- d%�d&d'�Z1dS ))z SSH: Configure SSH and SSH keys� N)�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
Zcc_sshZSSHzConfigure 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� descriptionZdistrosZ frequencyZexamplesZactivate_by_schema_keysZrsaZdsaZecdsaZed25519z4^(ecdsa-sk|ed25519-sk)_(private|public|certificate)$z/etc/ssh/ssh_host_%s_keyTZ_privatei� Z_publicz.pubi� � _certificatez -cert.pubz;o=$(ssh-keygen -yf "%s") && echo "$o" root@localhost > "%s")r �cfg�cloud�args�returnc ( C s� |j dd�r`tjjdd�}xDtj|�D ]6}ytj|� W q& tk
rZ tjt d|� Y q&X q&W d|k�r�g }x�|d j
� D ]t\}}|t kr�t j
|�r�d} nd} t jd | |� q|t | d
}
t | d } tj|
|| � d |kr||jd
t|
�f� q|W |�rtj|� x�tj
� D ]�\} }
|
|d k�s| |d k�r6�qt | d
t |
d
}}ddt||f g}y:tjddd�� tj|dd� W d Q R X t jd||� W n. tk
�r� tjt d|� d|� �� Y nX �qW �n�tj|dt�}tj� �s�|n dd� |D �}t |�j |�}|�r&t jddj|�� tj j � }d |d < �x~|D �]t}t | }tjj!|��r`�q@tj"tjj#|�� d d |d d!d"|g}tjddd��� y�tj|d|d#�\}}tj$|d$d��s�t%j&j'tj(|�� tj)d�}|d8k�r6d%}tj*� }|�r
|tj+d&d
�k �r
d'}tj,|d9|� tj-||� tj-|� d(�d)� W np tj.k
�r� } zPtj(| j/�j0� }| j1d k�r�|j0� j2d*��r�t jd+|� ntjt d,||� W Y d d } ~ X nX W d Q R X �q@W d-|k�r�tj|d- d.t3�} tj$|d- d/t4�} nt3} t4} | �r6t5| d0�} y|j6j7| � W n" tk
�r4 tjt d1� Y nX y�t8j9||j:�\} }!t8j;| �\}"}#tj$|d2d�}$tj<|d3tj=�}%g }&tj$|d4d��r�|j>� �p�g }&n
t jd5� d6|k�r�|d6 }'|&j?|'� t@|&|"|$|%� W n" tk
�r� tjt d7� Y nX d S ):NZssh_deletekeysTz /etc/ssh/zssh_host_*key*zFailed deleting key file %sZssh_keysZ unsupportedZ unrecognizedz Skipping %s ssh_keys entry: "%s"r � r ZHostCertificateZshz-xcz/etc/ssh)� recursiveF)�capturez Generated a key for %s from %sz Failed generating a key for z from Zssh_genkeytypesc S s g | ]}|t kr|�qS � )�FIPS_UNSUPPORTED_KEY_NAMES)�.0�namesr r � /usr/lib/python3.6/cc_ssh.py�
<listcomp>
s zhandle.<locals>.<listcomp>z5skipping keys that are not supported in fips mode: %s�,�CZLANGz
ssh-keygenz-tz-N� z-f)r �envZssh_quiet_keygeni� � i� z.pubi� z unknown keyz!ssh-keygen: unknown key type '%s'z(Failed generating key type %s to file %sZssh_publish_hostkeys� blacklistZenabled)r' z Publishing host keys failed!� disable_root�disable_root_optsZallow_public_ssh_keyszSSkipping import of publish SSH keys per config setting: allow_public_ssh_keys=FalseZssh_authorized_keysz Applying SSH credentials failed!���r* )A�get�os�path�join�globr Zdel_file� ExceptionZlogexc�LOG�items�CONFIG_KEY_TO_FILE� pattern_unsupported_config_keys�matchZwarningZ
write_file�append�strr Zappend_ssh_config� PRIV_TO_PUB� KEY_GEN_TPLZ SeLinuxGuardr �debugZget_cfg_option_list�GENERATE_KEY_NAMESZ fips_enabled�set�
difference�environ�copy� KEY_FILE_TPL�existsZ
ensure_dir�dirnameZget_cfg_option_bool�sys�stdout�writeZ
decode_binaryZ get_group_idZ get_opensshd_upstream_versionZVersion�chown�chmodZProcessExecutionError�stderr�lowerZ exit_code�
startswith�HOST_KEY_PUBLISH_BLACKLIST�PUBLISH_HOST_KEYS�get_public_host_keysZ
datasourceZpublish_host_keysr Znormalize_users_groupsZdistroZextract_defaultZget_cfg_option_strZDISABLE_USER_OPTSZget_public_ssh_keys�extend�apply_credentials)(r r r r Zkey_pth�fZ cert_config�key�val�reasonZtgt_fnZ tgt_permsZ private_typeZ public_typeZ private_fileZ public_file�cmdZgenkeysZ key_namesZ skipped_keysZlang_cZkeytypeZkeyfile�out�err�gidZpermissions_privateZ ssh_version�eZhost_key_blacklistZpublish_hostkeysZhostkeysZusersZ_groups�userZ _user_configr( r) �keysZcfgkeysr r r �handle� s�
"
(
r[ c C sV t | �} |rtj| |� |r>|s$d}|jd|�}|jdd�}nd}tj| d|d� d S )NZNONEz$USERz
$DISABLE_USER�rootr$ )Zoptions)r< r Zsetup_user_keys�replace)rZ rY r( r) Z
key_prefixr r r rO n s rO )r' c s� dt f �g }g � | r(�fdd�| D �� � fdd�tj�d �D �}xD|D ]<}tj|�}|j� }|rJt|�dkrJ|jt|dd� �� qJW |S )
a Read 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.pubc s g | ]}� |f �qS r r )r Zkey_type)�public_key_file_tmplr r r! � s z(get_public_host_keys.<locals>.<listcomp>c s g | ]}|� kr|�qS r r )r Zhostfile)�blacklist_filesr r r! � s �*r N� )r` )r@ r/ r Z load_file�split�lenr6 �tuple)r' Zkey_listZ file_list� file_nameZ
file_contentsZkey_datar )r_ r^ r rM s
rM )N)2�__doc__r/ Zloggingr, �rerC �textwrapr Ztypingr r r Z cloudinitr r r Zcloudinit.cloudr Zcloudinit.configr
Zcloudinit.config.schemar r Zcloudinit.distrosr
r Zcloudinit.settingsr ZMODULE_DESCRIPTION�metaZ getLogger�__name__r1 r; r �compiler4 r@ rL rK r3 r8 �k�updater9 r7 �listr[ rO rM r r r r �<module> sZ ^
'