o

�N�gL@�@s�dZd
dl
Z
d
dlZd
dlZd
dlZe�e�
ZdZ	dd�Z
dd�Zdd	�Zd
d�Z
dd
�Zdd�Zdd�Zdd�Zdd�Zddd�
ZdS)a�

Network Users
=============

Manage the users configuration on network devices via the NAPALM proxy.

:codeauthor: Mircea Ulinic <ping@mirceaulinic.net>
:maturity:   new
:depends:    napalm
:platform:   unix

Dependencies
------------
- :mod:`NAPALM proxy minion <salt.proxy.napalm>`
- :mod:`Users configuration management module <salt.modules.napalm_users>`

.. versionadded:: 2016.11.0
�NZnetuserscCstj
j�ttt�S)
z_
    NAPALM library must be installed for this module to work and run in a (proxy) minion.
    )�salt�utilsZnapalmZvirtual�__opts__�__virtualname__�__file__�rr�H/opt/saltstack/salt/lib/python3.10/site-packages/salt/states/netusers.py�__virtual__,sr	cCs
td
�S)zRetrieves configured userszusers.config�
�__salt__rrrr�_retrieve_users8s
rc

Cstj
j�tj
j�|�
�
S)
�
.)rr�json�loads�dumps)
Zprobesrrr�_ordered_dict_to_dict>srcCst�
|
�
}|�|�

|S)
z6Creates a longer list of accepted users on the device.)�copy�deepcopy�update)Zdevice_usersZcommon_users�expected_usersrrr�
_expand_usersDs


rc
Csxd
}
d}|��D]/\}}|sd}|
d|�d�7}
qt
|�d�
t�s7d|�d�
k
r.dk
s7n

|
d	j|d
�
7}
q||
fS)z1Checks if the input dictionary of users is valid.�TFz$Please provide details for username z.
�levelr
�zMLevel must be a integer between 0 and 15 for username {user}. Will assume 0.
)
�user)�items�
isinstance�get�int�format)�usersZmessg�validrZuser_detailsrrr�_check_usersMs"




�

���r"cs�iiid
�}t��
��
}t�
�
��
}||}||}||@}�
f
dd�|D�
}�f
dd�|D�
}	i}
|D]+}��|�
}�
�|�
}
||
krEq4i|
|<|
��D]\}}|�|�
|kr^||
||<qMq4|�||
|	d
��

|S)zJComputes the differences between the actual config and the expected config)�addr�removec
�i|]}
|
��|
�
�qSr�
r��.0�username)
�expectedrr�
<dictcomp>q�z!_compute_diff.<locals>.<dictcomp>c
r%rr&r')
�
configuredrrr+rr,)�set�keysrrr)r-r*�diff�configured_usersrZ
add_usernamesZremove_usernamesZcommon_usernamesr#r$rr)Zuser_configurationZ
user_expected�fieldZfield_valuer)r-r*r�
_compute_diffes,














��r3c

C�td
|dd�S�zCalls users.set_users.zusers.set_usersF�
Zcommitr
�
r rrr�
_set_users��r8c

Cr4r5r
r7rrr�
_update_users�r9r:c

Cr4)zCalls users.delete_users.zusers.delete_usersFr6r
r7rrr�
_delete_users�r9r;cCsd
}d}i}||||d�}t|
�
}
t|�
}t
|
|�}t|�
\}}	|s,dj|	d�
|d<|St�}
|
�d�
sAdj|
�d�
d	�
|d<|S|
�d
i�}||krU|�ddd
��

|St||�}|�di�}
|�di�}|�di�}|
||d�}|�d|i
�

tddur�|�ddd��

|Sd
}d}|
r�t	|
�
}|�d�
r�d}n
d
}|dj|�d�
d	�
7}|r�t
|�
}|�d�
r�d}n
d
}|dj|�d�
d	�
7}|r�t|�
}|�d�
r�d}n
d
}|dj|�d�
d	�
7}|r�|r�td�\}}|}||7}|r�|r�|s�d}|�||d��

|S)a[
    Manages the configuration of the users on the device, as specified in the state SLS file. Users not defined in that
    file will be removed whilst users not configured on the device, will be added.

    SLS Example:

    .. code-block:: yaml

        netusers_example:
            netusers.managed:
                 - users:
                    admin:
                        level: 15
                        password: $1$knmhgPPv$g8745biu4rb.Zf.IT.F/U1
                        sshkeys: []
                    restricted:
                        level: 1
                        password: $1$j34j5k4b$4d5SVjTiz1l.Zf.IT.F/K7
                    martin:
                        level: 15
                        password: ''
                        sshkeys:
                            - ssh-dss AAAAB3NzaC1kc3MAAACBAK9dP3KariMlM/JmFW9rTSm5cXs4nR0+o6fTHP9o+bOLXMBTP8R4vwWHh0w
                                JPjQmJYafAqZTnlgi0srGjyifFwPtODppDWLCgLe2M4LXnu3OMqknr54w344zPHP3iFwWxHrBrZKtCjO8LhbWCa+
                                X528+i87t6r5e4ersdfxgchvjbknlio87t6r5drcfhgjhbknio8976tycv7t86ftyiu87Oz1nKsKuNzm2csoUQlJ
                                trmRfpjsOPNookmOz5wG0YxhwDmKeo6fWK+ATk1OiP+QT39fn4G77j8o+e4WAwxM570s35Of/vV0zoOccj753sXn
                                pvJenvwpM2H6o3a9ALvehAJKWodAgZT7X8+iu786r5drtycghvjbiu78t+wAAAIBURwSPZVElXe+9a43sF6M4ysT
                                7Xv+6wTsa8q86E3+RYyu8O2ObI2kwNLC3/HTgFniE/YqRG+WJac81/VHWQNP822gns8RVrWKjqBktmQoEm7z5yy0
                                bkjui78675dytcghvjkoi9y7t867ftcuvhbuu9t78gy/v+zvMmv8KvQgHg
                    jonathan:
                        level: 15
                        password: ''
                        sshkeys:
                            - ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDcgxE6HZF/xjFtIt0thEDKPjFJxW9BpZtTVstYbDgGR9zPkHG
                                ZJT/j345jk345jk453jk43545j35nl3kln34n5kl4ghv3/JzWt/0Js5KZp/51KRNCs9O4t07qaoqwpLB15GwLfEX
                                Bx9dW26zc4O+hi6754trxcfghvjbo98765drt/LYIEg0KSQPWyJEK1g31gacbxN7Ab006xeHh7rv7HtXF6zH3WId
                                Uhq9rtdUag6kYnv6qvjG7sbCyHGYu5vZB7GytnNuVNbZuI+RdFvmHSnErV9HCu9xZBq6DBb+sESMS4s7nFcsruMo
                                edb+BAc3aww0naeWpogjSt+We7y2N

    CLI Example:

    .. code-block:: bash

        salt 'edge01.kix01' state.sls router.users

    Output example (raw python - can be reused in other modules):

    .. code-block:: python

        {
            'netusers_|-netusers_example_|-netusers_example_|-managed': {
                'comment': 'Configuration updated!',
                'name': 'netusers_example',
                'start_time': '10:57:08.678811',
                '__id__': 'netusers_example',
                'duration': 1620.982,
                '__run_num__': 0,
                'changes': {
                    'updated': {
                        'admin': {
                            'level': 15
                        },
                        'restricted': {
                            'level': 1
                        },
                        'martin': {
                            'sshkeys': [
                                'ssh-dss AAAAB3NzaC1kc3MAAACBAK9dP3KariMlM/JmFW9rTSm5cXs4nR0+o6fTHP9o+bOLXMBTP8R4vwWHh0w
                                JPjQmJYafAqZTnlgi0srGjyifFwPtODppDWLCgLe2M4LXnu3OMqknr54w344zPHP3iFwWxHrBrZKtCjO8LhbWCa+
                                X528+i87t6r5e4ersdfxgchvjbknlio87t6r5drcfhgjhbknio8976tycv7t86ftyiu87Oz1nKsKuNzm2csoUQlJ
                                trmRfpjsOPNookmOz5wG0YxhwDmKeo6fWK+ATk1OiP+QT39fn4G77j8o+e4WAwxM570s35Of/vV0zoOccj753sXn
                                pvJenvwpM2H6o3a9ALvehAJKWodAgZT7X8+iu786r5drtycghvjbiu78t+wAAAIBURwSPZVElXe+9a43sF6M4ysT
                                7Xv+6wTsa8q86E3+RYyu8O2ObI2kwNLC3/HTgFniE/YqRG+WJac81/VHWQNP822gns8RVrWKjqBktmQoEm7z5yy0
                                bkjui78675dytcghvjkoi9y7t867ftcuvhbuu9t78gy/v+zvMmv8KvQgHg'
                            ]
                        }
                    },
                    'added': {
                        'jonathan': {
                            'password': '',
                            'sshkeys': [
                                'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDcgxE6HZF/xjFtIt0thEDKPjFJxW9BpZtTVstYbDgGR9zPkHG
                                ZJT/j345jk345jk453jk43545j35nl3kln34n5kl4ghv3/JzWt/0Js5KZp/51KRNCs9O4t07qaoqwpLB15GwLfEX
                                Bx9dW26zc4O+hi6754trxcfghvjbo98765drt/LYIEg0KSQPWyJEK1g31gacbxN7Ab006xeHh7rv7HtXF6zH3WId
                                Uhq9rtdUag6kYnv6qvjG7sbCyHGYu5vZB7GytnNuVNbZuI+RdFvmHSnErV9HCu9xZBq6DBb+sESMS4s7nFcsruMo
                                edb+BAc3aww0naeWpogjSt+We7y2N'
                            ],
                            'level': 15
                        }
                    },
                    'removed': {
                    }
                },
                'result': True
            }
        }

    CLI Output:

    .. code-block:: bash

        edge01.kix01:
            ----------
                      ID: netusers_example
                Function: netusers.managed
                  Result: True
                 Comment: Configuration updated!
                 Started: 11:03:31.957725
                Duration: 1220.435 ms
                 Changes:
                          ----------
                          added:
                              ----------
                              jonathan:
                                  ----------
                                  level:
                                      15
                                  password:
                                  sshkeys:
                                      - ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDcgxE6HZF/xjFtIt0thEDKPjFJxW9BpZtTVstYbDgG
                                      R9zPkHGZJT/j345jk345jk453jk43545j35nl3kln34n5kl4ghv3/JzWt/0Js5KZp/51KRNCs9O4t07qao
                                      qwpLB15GwLfEXBx9dW26zc4O+hi6754trxcfghvjbo98765drt/LYIEg0KSQPWyJEK1g31gacbxN7Ab006
                                      xeHh7rv7HtXF6zH3WIdUhq9rtdUag6kYnv6qvjG7sbCyHGYu5vZB7GytnNuVNbZuI+RdFvmHSnErV9HCu9
                                      xZBq6DBb+sESMS4s7nFcsruMoedb+BAc3aww0naeWpogjSt+We7y2N
                          removed:
                              ----------
                          updated:
                              ----------
                              martin:
                                  ----------
                                  sshkeys:
                                      - ssh-dss AAAAB3NzaC1kc3MAAACBAK9dP3KariMlM/JmFW9rTSm5cXs4nR0+o6fTHP9o+bOLXMBTP8R4
                                      vwWHh0wJPjQmJYafAqZTnlgi0srGjyifFwPtODppDWLCgLe2M4LXnu3OMqknr54w344zPHP3iFwWxHrBrZ
                                      KtCjO8LhbWCa+X528+i87t6r5e4ersdfxgchvjbknlio87t6r5drcfhgjhbknio8976tycv7t86ftyiu87
                                      Oz1nKsKuNzm2csoUQlJtrmRfpjsOPNookmOz5wG0YxhwDmKeo6fWK+ATk1OiP+QT39fn4G77j8o+e4WAwx
                                      M570s35Of/vV0zoOccj753sXnpvJenvwpM2H6o3a9ALvehAJKWodAgZT7X8+iu786r5drtycghvjbiu78t
                                      +wAAAIBURwSPZVElXe+9a43sF6M4ysT7Xv+6wTsa8q86E3+RYyu8O2ObI2kwNLC3/HTgFniE/YqRG+WJac
                                      81/VHWQNP822gns8RVrWKjqBktmQoEm7z5yy0bkjui78675dytcghvjkoi9y7t867ftcuvhbuu9t78gy/v
                                      +zvMmv8KvQgHg
                              admin:
                                  ----------
                                  level:
                                      15
                              restricted:
                                  ----------
                                  level:
                                      1
            Summary for edge01.kix01
            ------------
            Succeeded: 1 (changed=1)
            Failed:    0
            ------------
            Total states run:     1
            Total run time:   1.220 s
    Fr)�name�changes�result�commentz-Please provide a valid configuration: {error})
�errorr?r>z/Cannot retrieve users from the device: {reason})
�reason�outz#Users already configured as needed.T)r?r>r#rr$)Zadded�updatedZremovedr=�testNz,Testing mode: configuration was not changed!)r>r?z$Cannot configure new users: {reason}z/Cannot update the users configuration: {reason}zCannot remove users: {reason}znet.config_controlzConfiguration updated!)
rrr"rrrrr3rr8r:r;r)r<r �defaultsr>r?r=�retrr!�messageZusers_outputr1r0Zusers_to_addZusers_to_updateZusers_to_removeZexpected_config_changeZsuccessfully_changedZ_setZ_update�_deleteZ
config_resultZconfig_commentrrr�managed�s�







�




�






�

�






�





�





�



rI)NN)�__doc__r�loggingZsalt.utils.jsonrZsalt.utils.napalm�	getLogger�__name__�logrr	rrrr"r3r8r:r;rIrrrr�<module>
s"