Current File : //usr/lib/python2.7/site-packages/salt/modules/win_useradd.pyc
�
���^c @@ s� d Z d d l m Z m Z m Z d d l Z d d l Z d d l m Z y d d l m Z
Wn! e k
r� d d l m Z
n Xd d l
Z d d l Z d d l Z d d l Z d d l m Z d d l m Z d d l m Z e j e � Z yv d d l Z d d l Z d d l Z d d l Z d d l Z d d l Z d d l! Z! d d l" Z" d d l# Z# e$ Z% Wn e& k
r�e' Z% n Xd Z( d
� Z) d � Z* d d d d d d d d d � Z, d d d d d d d d d d d d d d
�
Z- e' e' d � Z. d � Z/ d � Z0 d � Z1 d � Z2 d � Z3 d � Z4 d � Z5 e$ d � Z6 d � Z7 d � Z8 d � Z9 e' d � Z: d � Z; d � Z< e' d � Z= d S( u5
Module for managing Windows Users
.. important::
If you feel that Salt should be using this module to manage users on a
minion, and it is using a different module (or gives an error similar to
*'user.info' is not available*), see :ref:`here
<module-provider-override>`.
:depends:
- pywintypes
- win32api
- win32con
- win32net
- win32netcon
- win32profile
- win32security
- win32ts
- wmi
.. note::
This currently only works with local user accounts, not domain accounts
i ( t absolute_importt unicode_literalst print_functionN( t datetime( t quote( t six( t string_types( t CommandExecutionErroru userc C@ s0 t j j j � s t d f St s, t d f St S( u.
Requires Windows and Windows Modules
u Module win_useradd: Windows Onlyu) Module win_useradd: Missing Win32 Modules( t saltt utilst platformt
is_windowst Falset HAS_WIN32NET_MODSt __virtualname__( ( ( s< /usr/lib/python2.7/site-packages/salt/modules/win_useradd.pyt __virtual__A s
c C@ s6 | d k s t | t j � r" | St j | d � Sd S( u�
Internal function for converting to Unicode Strings
The NetUser* series of API calls in this module requires input parameters to
be Unicode Strings. This function ensures the parameter is a Unicode String.
This only seems to be an issue in Python 2. All calls to this function
should be gated behind a ``if six.PY2`` check.
Args:
instr (str): String to convert
Returns:
str: Unicode type string
u utf-8N( t Nonet
isinstanceR t text_type( t instr( ( s< /usr/lib/python2.7/site-packages/salt/modules/win_useradd.pyt _to_unicodeN s c C@ s� t j rl t | � } t | � } t | � } t | � } t | � } t | � } t | � } t | � } n i } | r� | | d <n t S| | d <t j | d <| | d <| | d <t j | d <| | d <y t j d d | � Wn` t j
k
rD}
t j
d | � t j
d
|
j � t j
d |
j
� t j
d |
j � t SXt d
| d | d | d | � | ryt | | � n t } | S( u
Add a user to the minion.
Args:
name (str): User name
password (str, optional): User's password in plain text.
fullname (str, optional): The user's full name.
description (str, optional): A brief description of the user account.
groups (str, optional): A list of groups to add the user to.
(see chgroups)
home (str, optional): The path to the user's home directory.
homedrive (str, optional): The drive letter to assign to the home
directory. Must be the Drive Letter followed by a colon. ie: U:
profile (str, optional): An explicit path to a profile. Can be a UNC or
a folder on the system. If left blank, windows uses it's default
profile directory.
logonscript (str, optional): Path to a login script to run when the user
logs on.
Returns:
bool: True if successful. False is unsuccessful.
CLI Example:
.. code-block:: bash
salt '*' user.add name password
u nameu passwordu privu home_diru commentu flagsu script_pathi u Failed to create user %su nbr: %su ctx: %su msg: %st namet homedrivet profilet fullnameN( R t PY2R R t win32netcont USER_PRIV_USERt UF_SCRIPTt win32nett
NetUserAddR t errort logt winerrort funcnamet strerrort updatet chgroupst True( R t passwordR t descriptiont groupst homeR R t logonscriptt user_infot exct ret( ( s< /usr/lib/python2.7/site-packages/salt/modules/win_useradd.pyt addc sB -
c C@ s~ t j rl t | � } t | � } t | � } t | � } t | � } t | � } t | � } t | � } n y t j d | d � } Wn` t j k
r� } t j d | � t j d | j � t j d | j � t j d | j
� t SX| r� | | d <n | r| | d <n | r!| | d <n | r4| | d <n | rG| | d
<n | rZ| | d <n | rm| | d <n | r�| d
k r�t j
| d <q�y t j j j | � } Wn! t t f k
r�d j | � SXt j | j � � | d <n | d k r| rd | d <qd | d <n |
d k rS|
r<| d c t j O<qS| d c t j M<n | d k r| r| d c t j M<qn | d k r�| r�| d c t j O<q�| d c t j M<n |
d k r�|
r�| d c t j O<q�| d c t j M<n y t j d | d | � Wn` t j k
ry} t j d | � t j d | j � t j d | j � t j d | j
� t SXt S( uh
Updates settings for the windows user. Name is the only required parameter.
Settings will only be changed if the parameter is passed a value.
.. versionadded:: 2015.8.0
Args:
name (str): The user name to update.
password (str, optional): New user password in plain text.
fullname (str, optional): The user's full name.
description (str, optional): A brief description of the user account.
home (str, optional): The path to the user's home directory.
homedrive (str, optional): The drive letter to assign to the home
directory. Must be the Drive Letter followed by a colon. ie: U:
logonscript (str, optional): The path to the logon script.
profile (str, optional): The path to the user's profile directory.
expiration_date (date, optional): The date and time when the account
expires. Can be a valid date/time string. To set to never expire
pass the string 'Never'.
expired (bool, optional): Pass `True` to expire the account. The user
will be prompted to change their password at the next logon. Pass
`False` to mark the account as 'not expired'. You can't use this to
negate the expiration if the expiration was caused by the account
expiring. You'll have to change the `expiration_date` as well.
account_disabled (bool, optional): True disables the account. False
enables the account.
unlock_account (bool, optional): True unlocks a locked user account.
False is ignored.
password_never_expires (bool, optional): True sets the password to never
expire. False allows the password to expire.
disallow_change_password (bool, optional): True blocks the user from
changing the password. False allows the user to change the password.
Returns:
bool: True if successful. False is unsuccessful.
CLI Example:
.. code-block:: bash
salt '*' user.update bob password=secret profile=C:\Users\Bob
home=\server\homeshareob homedrive=U:
i u Failed to update user %su nbr: %su ctx: %su msg: %su passwordu home_diru home_dir_driveu commentu script_pathu full_nameu profileu Neveru acct_expiresu Invalid Date/Time Format: {0}i u password_expiredi u flagsN( R R R R t NetUserGetInfoR R R R! R" R# R R t
TIMEQ_FOREVERR R t dateutilst date_castt
ValueErrort RuntimeErrort formatt timet mktimet timetuplet UF_ACCOUNTDISABLEt
UF_LOCKOUTt UF_DONT_EXPIRE_PASSWDt UF_PASSWD_CANT_CHANGEt NetUserSetInfoR& ( R R' R R( R* R R+ R t expiration_datet expiredt account_disabledt unlock_accountt password_never_expirest disallow_change_passwordR, R- t dt_obj( ( s< /usr/lib/python2.7/site-packages/salt/modules/win_useradd.pyR$ � s� H
c
C@ s t j r t | � } n y t j d | d � } Wn` t j k
r� } t j d | � t j d | j � t j d | j � t j d | j
� t SXy t j
� } Wn\ t j k
r} t j d � t j d | j � t j d | j � t j d | j
� n Xt } d } xC | D]; } t j d | d t j � | k r| d } t } qqW| r�| r�y t j t j | t � Wq�t j k
r�} t j d | � t j d | j � t j d | j � t j d | j
� t SXq�t j d | � t Sn | r�y t | � } t j | � Wq�t j k
r�} | j \ }
} } |
d k rQq�t j d
| � t j d | j � t j d | j � t j d | j
� t Sq�Xn y t j d | � Wn` t j k
r} t j d | � t j d | j � t j d | j � t j d | j
� t SXt S(
u�
Remove a user from the minion
Args:
name (str): The name of the user to delete
purge (bool, optional): Boolean value indicating that the user profile
should also be removed when the user account is deleted. If set to
True the profile will be removed. Default is False.
force (bool, optional): Boolean value indicating that the user account
should be deleted even if the user is logged in. True will log the
user out and delete user.
Returns:
bool: True if successful, otherwise False
CLI Example:
.. code-block:: bash
salt '*' user.delete name
i u User not found: %su nbr: %su ctx: %su msg: %su No logged in users foundu SessionIdu User %s is currently logged in.i u Failed to remove profile for %su Failed to delete user %sN( R R R R R0 R R R R! R" R# R t win32tst WTSEnumerateSessionst WTSQuerySessionInformationt WTSUserNameR& t WTSLogoffSessiont WTS_CURRENT_SERVER_HANDLEt
getUserSidt win32profilet
DeleteProfilet
pywintypest argst
NetUserDel(
R t purget forceR, R- t sess_listt logged_int
session_idt sesst sidt numbert contextt message( ( s< /usr/lib/python2.7/site-packages/salt/modules/win_useradd.pyt deleteT sr
"
c C@ s� t j r t | � } n t j � } | j d � d k rb | j d � d } | j d � d } n | j � } t j t j
d | d | � d � S( u�
Get the Security ID for the user
Args:
username (str): The user name for which to look up the SID
Returns:
str: The user SID
CLI Example:
.. code-block:: bash
salt '*' user.getUserSid jsnuffy
u \i����i N( R R R t win32apit GetComputerNamet findt splitt uppert
win32securityt ConvertSidToStringSidt LookupAccountNameR ( t usernamet domain( ( s< /usr/lib/python2.7/site-packages/salt/modules/win_useradd.pyRL � s c C@ s t d | d | � S( u9
Set the user's password
Args:
name (str): The user name for which to set the password
password (str): The new password
Returns:
bool: True if successful, otherwise False
CLI Example:
.. code-block:: bash
salt '*' user.setpassword jsnuffy sup3rs3cr3t
R R' ( R$ ( R R' ( ( s< /usr/lib/python2.7/site-packages/salt/modules/win_useradd.pyt setpassword� s c C@ s� t j r$ t | � } t | � } n t | � } t | � j d � j d � } t | � } | sd t S| | d k rx t Sd j | | � } t
d | d t �} | d d k S( uE
Add user to a group
Args:
name (str): The user name to add to the group
group (str): The name of the group to which to add the user
Returns:
bool: True if successful, otherwise False
CLI Example:
.. code-block:: bash
salt '*' user.addgroup jsnuffy 'Power Users'
u 'u groupsu net localgroup "{0}" {1} /addu cmd.run_allt python_shellu retcodei ( R R R t
_cmd_quotet lstript rstript infoR R& R6 t __salt__( R t groupt usert cmdR. ( ( s< /usr/lib/python2.7/site-packages/salt/modules/win_useradd.pyt addgroup� s c C@ s� t j r$ t | � } t | � } n t | � } t | � j d � j d � } t | � } | sd t S| | d k rx t Sd j | | � } t
d | d t �} | d d k S( uW
Remove user from a group
Args:
name (str): The user name to remove from the group
group (str): The name of the group from which to remove the user
Returns:
bool: True if successful, otherwise False
CLI Example:
.. code-block:: bash
salt '*' user.removegroup jsnuffy 'Power Users'
u 'u groupsu net localgroup "{0}" {1} /deleteu cmd.run_allRh u retcodei ( R R R Ri Rj Rk Rl R R& R6 Rm ( R Rn Ro Rp R. ( ( s< /usr/lib/python2.7/site-packages/salt/modules/win_useradd.pyt removegroup s c K@ s� t j r$ t | � } t | � } n t j j j | � } | j d t � } | rg t j j j | � n | r} t
j d � n t | � } | s� t S| | d k r� t St
d | d | � s� t St | � } | d | d k r� | d | k St S( u�
Change the home directory of the user, pass True for persist to move files
to the new home directory if the old home directory exist.
Args:
name (str): The name of the user whose home directory you wish to change
home (str): The new location of the home directory
Returns:
bool: True if successful, otherwise False
CLI Example:
.. code-block:: bash
salt '*' user.chhome foo \\fileserver\home\foo True
u persistu6 Ignoring unsupported 'persist' argument to user.chhomeu homeR R* ( R R R R R RP t clean_kwargst popR t invalid_kwargsR Rl R& R$ ( R R* t kwargst persistt pre_infot post_info( ( s< /usr/lib/python2.7/site-packages/salt/modules/win_useradd.pyt chhome7 s( c C@ s t d | d | � S( uj
Change the profile directory of the user
Args:
name (str): The name of the user whose profile you wish to change
profile (str): The new location of the profile
Returns:
bool: True if successful, otherwise False
CLI Example:
.. code-block:: bash
salt '*' user.chprofile foo \\fileserver\profiles\foo
R R ( R$ ( R R ( ( s< /usr/lib/python2.7/site-packages/salt/modules/win_useradd.pyt chprofileg s c C@ s t d | d | � S( uR
Change the full name of the user
Args:
name (str): The user name for which to change the full name
fullname (str): The new value for the full name
Returns:
bool: True if successful, otherwise False
CLI Example:
.. code-block:: bash
salt '*' user.chfullname user 'First Last'
R R ( R$ ( R R ( ( s< /usr/lib/python2.7/site-packages/salt/modules/win_useradd.pyt
chfullname| s c C@ s� t j r t | � } n t | t � r9 | j d � } n g | D] } | j d � ^ q@ } t j r� g | D] } t | � ^ qk } n t t | � � } | t | � k r� t St
| � } | s'xd | D]Y } t
| � j d � j d � } | | k r� d j
| | � } t d | d t �q� q� Wn x� | D]� } | | k rFq.n t
| � j d � j d � } d j
| | � } t d | d t �} | d d k r.t j | d
� t Sq.Wt t | � � } t | | � d k S( u�
Change the groups this user belongs to, add append=False to make the user a
member of only the specified groups
Args:
name (str): The user name for which to change groups
groups (str, list): A single group or a list of groups to assign to the
user. For multiple groups this can be a comma delimited string or a
list.
append (bool, optional): True adds the passed groups to the user's
current groups. False sets the user's groups to the passed groups
only. Default is True.
Returns:
bool: True if successful, otherwise False
CLI Example:
.. code-block:: bash
salt '*' user.chgroups jsnuffy Administrators,Users True
u ,u *u 'u net localgroup "{0}" {1} /deleteu cmd.run_allRh u net localgroup "{0}" {1} /addu retcodei u stdout( R R R R R R` t stript sett list_groupsR& Ri Rj Rk R6 Rm R R R t len( R R) t appendt xt ugrpsRn Rp t outt agrps( ( s< /usr/lib/python2.7/site-packages/salt/modules/win_useradd.pyR% � s8 " "
c C@ s! t j r t | � } n i } i } y t j d* | d � } Wn t j k
rS n X| rg } y t j d* | � } Wn t j k
r� n X| d | d <| d | d <t j | d � | d <| d | d <| d | d <| d | d
<t
| d t j @� | d <| d
| d <| d | d <| d | d <| d | d <t
j t j � j � � | d } t j | � j d � | d <| d d k r�d | d <n t j | d � j d � | d <t j | d � j d � | d <| d d k | d <| d st | | d � | d <n | d | d <| d! | d" <| d sI| d | d <n | | d# <| d t j @d k rwt | d$ <n
t | d$ <| d t j @d k r�t | d% <n
t | d% <| d t j @d k r�t | d& <n
t | d& <| d t j @d k rt | d' <n
t | d' <d( | d) <| Si Sd* S(+ u~
Return user information
Args:
name (str): Username for which to display information
Returns:
dict: A dictionary containing user information
- fullname
- username
- SID
- passwd (will always return None)
- comment (same as description, left here for backwards compatibility)
- description
- active
- logonscript
- profile
- home
- homedrive
- groups
- password_changed
- successful_logon_attempts
- failed_logon_attempts
- last_logon
- account_disabled
- account_locked
- password_never_expires
- disallow_change_password
- gid
CLI Example:
.. code-block:: bash
salt '*' user.info jsnuffy
i u full_nameu fullnameu nameu user_sidu uidu passwordu passwdu commentu descriptionu flagsu activeu script_pathu logonscriptu profileu bad_pw_countu failed_logon_attemptsu
num_logonsu successful_logon_attemptsu password_ageu %Y-%m-%d %H:%M:%Su password_changedu
last_logoni u Neveru acct_expiresu expiration_dateu password_expiredi u expiredu home_diru homeu home_dir_driveu homedriveu groupsu password_never_expiresu account_disabledu account_lockedu disallow_change_passwordu u gidN( R R R R R0 R R t NetUserGetLocalGroupsRb Rc t boolR R: R7 R8 R t nowR9 t
fromtimestampt strftimet _get_userprofile_from_registryR< R R& R; R= ( R R. t itemsR) t secs( ( s< /usr/lib/python2.7/site-packages/salt/modules/win_useradd.pyRl � sr % #
c C@ s= t d d d j | � d � d } t j d | | | � | S( u
In case net user doesn't return the userprofile we can get it from the
registry
Args:
user (str): The user name, used in debug message
sid (str): The sid to lookup in the registry
Returns:
str: Profile directory
u reg.read_valueu HKEY_LOCAL_MACHINEu< SOFTWARE\Microsoft\Windows NT\CurrentVersion\ProfileList\{0}u ProfileImagePathu vdatau. user %s with sid=%s profile is located at "%s"( Rm R6 R t debug( Ro RX t profile_dir( ( s< /usr/lib/python2.7/site-packages/salt/modules/win_useradd.pyR� < s
c C@ s� t j r t | � } n t � } y t | � d } Wn t k
rI t SXx$ | D] } | j | j d � � qQ Wt t
| � � S( u
Return a list of groups the named user belongs to
Args:
name (str): The user name for which to list groups
Returns:
list: A list of groups to which the user belongs
CLI Example:
.. code-block:: bash
salt '*' user.list_groups foo
u groupsu *( R R R R~ Rl t KeyErrorR R/ R} t sortedt list( R t ugrpRo Rn ( ( s< /usr/lib/python2.7/site-packages/salt/modules/win_useradd.pyR U s
c C@ s� d t k r | r t d Sg } x� t d � D]� } i } t d | � } d | d <| d | d <| d | d <| d | d <| d | d <d | d
<| d | d <| j | � q/ W| t d <| S( uz
Return the list of all info for all users
Args:
refresh (bool, optional): Refresh the cached user information. Useful
when used from within a state function. Default is False.
Returns:
dict: A dictionary containing information about all users on the system
CLI Example:
.. code-block:: bash
salt '*' user.getent
u user.getentu user.list_usersu user.infou u gidu groupsu homeu nameu passwdu shellu uid( t __context__Rm R� ( t refreshR. Ro t stuffR, ( ( s< /usr/lib/python2.7/site-packages/salt/modules/win_useradd.pyt getents s
c C@ s� d } g } t } ym xb | s$ | ry t } t j d d t j | t j � \ } } } x | D] } | j | d � q[ Wq W| SWn t j k
r� n Xd S( u�
Return a list of all users on Windows
Returns:
list: A list of all users on the system
CLI Example:
.. code-block:: bash
salt '*' user.list_users
i u nameN(
R& R R t NetUserEnumR R t FILTER_NORMAL_ACCOUNTt MAX_PREFERRED_LENGTHR� R ( t rest user_listt dowhilet userst _Ro ( ( s< /usr/lib/python2.7/site-packages/salt/modules/win_useradd.pyt
list_users� s"
c C@ s� t j r$ t | � } t | � } n t | � } | sN t d j | � � � n t | � } | rx t d j | � � � n t j j j � � t
j d d � } Wd QXy | j d | � d } Wn& t
k
r� t d j | � � � n X| j | � d } | d k szi d d 6d d 6d
d 6d d
6d d 6d d 6d d 6d d 6d d 6d d 6d d 6} t d j | | | | � � � n t | � j d � | k S( u9
Change the username for a named user
Args:
name (str): The user name to change
new_name (str): The new name for the current user
Returns:
bool: True if successful, otherwise False
CLI Example:
.. code-block:: bash
salt '*' user.rename jsnuffy jshmoe
u User '{0}' does not existu User '{0}' already existst find_classesi Nt Nameu Successu Instance not foundi u Instance requiredi u Invalid parameteri u User not foundi u Domain not foundi uH Operation is allowed only on the primary domain controller of the domaini u; Operation is not allowed on the last administrative accounti uR Operation is not allowed on specified special groups: user, admin, local, or guesti u Other API errori u Internal errori
u6 There was an error renaming '{0}' to '{1}'. Error: {2}u name( R R R Rl R R6 R R t winapit Comt wmit WMIt Win32_UserAccountt
IndexErrort Renamet get( R t new_namet current_infot new_infot cRo t resultt
error_dict( ( s< /usr/lib/python2.7/site-packages/salt/modules/win_useradd.pyt rename� sB
c C@ s� y+ | r t j t j � } n t j � } Wnn t j k
r� } t j d � t j d | j � t j d | j � t j d | j
� t d d | �� n X| s� t d � � n | S( um
Get the username that salt-minion is running under. If salt-minion is
running as a service it should return the Local System account. If salt is
running from a command prompt it should return the username that started the
command prompt.
.. versionadded:: 2015.5.6
Args:
sam (bool, optional): False returns just the username without any domain
notation. True returns the domain with the username in the SAM
format. Ie: ``domain\username``
Returns:
str: Returns username
CLI Example:
.. code-block:: bash
salt '*' user.current
u Failed to get current useru nbr: %su ctx: %su msg: %sRl ( R] t
GetUserNameExt win32cont NameSamCompatiblet GetUserNameRO R R R! R" R# R ( t samt user_nameR- ( ( s< /usr/lib/python2.7/site-packages/salt/modules/win_useradd.pyt current s
(> t __doc__t
__future__R R R t loggingR7 R t shlexR Ri t Exceptiont pipest salt.utils.argsR t salt.utils.dateutilst salt.utils.platformt salt.utils.winapit salt.extR t salt.ext.sixR t salt.exceptionsR t getLoggert __name__R RO R� R] R� R R RM Rb RF R& R
t ImportErrorR R R R R R/ R$ R\ RL Rg Rq Rr Rz R{ R| R% Rl R� R R� R� R� R� ( ( ( s< /usr/lib/python2.7/site-packages/salt/modules/win_useradd.pyt <module> s�
O � d % ' 0 > m ' ! F
Mini Shell