File manager - Edit - /opt/saltstack/salt/lib/python3.10/site-packages/salt/utils/__pycache__/win_reg.cpython-310.pyc
Back
o ;j�z � @ s d Z ddlZddlZddlZddlmZ zddlZddlZddl Z dZ W n e y/ dZ Y nw e� e �ZdZdd� Zd d � Zd d � ZG d d� d�Zd$dd�Zd$dd�Zdd� Zd%dd�Zd%dd�Zd%dd�Z d&d d �Zd'd d �Zd$d d!�Z d%d"d#�Z dS )(aM Manage the Windows registry ----- Hives ----- Hives are the main sections of the registry and all begin with the word HKEY. - HKEY_LOCAL_MACHINE - HKEY_CURRENT_USER - HKEY_USER ---- Keys ---- Keys are the folders in the registry. Keys can have many nested subkeys. Keys can have a value assigned to them under the (Default) value name ----------------- Values or Entries ----------------- Values/Entries are name/data pairs. There can be many values in a key. The (Default) value corresponds to the Key itself, the rest are their own name/value pairs. :depends: PyWin32 � N)�CommandExecutionErrorTFZregc C s t jj�� sdS ts dS tS )z8 Only works on Windows systems with the PyWin32 )FzPreg execution module failed to load: The module will only run on Windows systems)Fznreg execution module failed to load: One of the following libraries did not load: win32gui, win32con, win32api)�salt�utils�platformZ is_windows�HAS_WINDOWS_MODULES�__virtualname__� r r �F/opt/saltstack/salt/lib/python3.10/site-packages/salt/utils/win_reg.py� __virtual__3 s r c C s t jj�| d�S )zq Converts unicode to current users character encoding. Use this for values returned by reg functions �mbcs)r r � stringutils� to_unicode��vdatar r r �_to_mbcsI s r c C s. | du rd} t | t�rt| �} tjj�| d�S )z| Converts from current users character encoding to unicode. Use this for parameters being pass to reg functions N� �utf-8)� isinstance�int�strr r r r r r r r � _to_unicodeQ s r c @ s e Zd ZdZdd� Zdd� ZdS )�Registryz� This was put in a class to delay usage until this module is actually used This class contains all the lookup dicts for working with the registry c C s� t std��tjtjtjtjtjtjtjtjtjtjd� | _dtj tj tj tj tj tjd�| _ddd�| _ddtj dtj d tj d tj d tj d tjd i| _ddd�| _tjdtjdtjdtjdtjdi| _tjtjB tjd�| _d S )Nz:Registry functionality requires 'pywin32' to be installed.) �HKEY_CURRENT_CONFIG�HKEY_CLASSES_ROOT�HKEY_CURRENT_USER�HKEY_LOCAL_MACHINE� HKEY_USERSZHKCCZHKCRZHKCUZHKLMZHKUr )�REG_NONE� REG_BINARY� REG_DWORD� REG_EXPAND_SZ� REG_MULTI_SZ�REG_SZ� REG_QWORD� )�REG_OPTION_NON_VOLATILE�REG_OPTION_VOLATILEr r r r r! r" r# r% r& )r r$ )TF)r r �win32conr r r r r �hkeysr r r r! r" r# �vtype�opttype� vtype_reverseZopttype_reverse�subkey_slash_checkZKEY_READZKEY_WOW64_32KEY� registry_32)�selfr r r �__init__d sT �� � � � �zRegistry.__init__c C s< z| j | W S ty d}d�| j �}t|�||���w )Nz#No hkey named '{0}. Try one of {1}'z, )r( �KeyError�joinr �format)r. �k�msgr( r r r � __getattr__� s �zRegistry.__getattr__N)�__name__� __module__� __qualname__�__doc__r/ r5 r r r r r ^ s 5r c C s t | �}t |�}t� }z|j| }W n ty td|� ���w |j| }d}zPzt�||d|�}W W |r=t�|� dS dS tj yx } z-| j dkr]W Y d} ~ W |r[t�|� dS dS | j dkrsW Y d} ~ W |rqt�|� dS dS � d} ~ ww |r�t�|� w w )a Check that the key is found in the registry. This refers to keys and not value/data pairs. To check value/data pairs, use ``value_exists`` Args: hive (str): The hive to connect to key (str): The key to check use_32bit_registry (bool): Look in the 32bit portion of the registry Returns: bool: True if exists, otherwise False Usage: .. code-block:: python import salt.utils.win_reg as reg reg.key_exists(hive='HKLM', key='SOFTWARE\Microsoft') �Invalid Hive: Nr T� F� ) r r r( r0 r r- �win32api� RegOpenKeyEx� RegCloseKey�error�winerror) �hive�key�use_32bit_registry� local_hive� local_key�registry�hkey� access_mask�handle�excr r r � key_exists� sB � �� � � ���� �rL c C sN t | �}t |�}t |�}t� }z|j| }W n ty$ td|� ���w |j| } z t�||d| �} W n tjyN } z | j dkrIW Y d} ~ dS � d} ~ ww zNzt� | |�\} } W W | rdt� | � dS dS tjy� } z+| j dkr�|du r�W Y d} ~ W | r�t� | � dS dS W Y d} ~ W | r�t� | � dS dS d} ~ ww | r�t� | � w w )a� Check that the value/data pair is found in the registry. .. versionadded:: 2018.3.4 Args: hive (str): The hive to connect to key (str): The key to check in vname (str): The name of the value/data pair you're checking use_32bit_registry (bool): Look in the 32bit portion of the registry Returns: bool: True if exists, otherwise False Usage: .. code-block:: python import salt.utils.win_reg as reg reg.value_exists(hive='HKLM', key='SOFTWARE\Microsoft\Windows\CurrentVersion', vname='CommonFilesDir') r: r r; NFT) r r r( r0 r r- r= r> r@ rA �RegQueryValueExr? ) rB rC �vnamerD rE rF � local_vnamerG rH rI rJ rK �_r r r � value_exists� sN � �� �� � ���� �rQ c C s( t �tjtjddtjd�\} }t|� S )ao Refresh the windows environment. .. note:: This will only effect new processes and windows. Services will not see the change until the system restarts. Returns: bool: True if successful, otherwise False Usage: .. code-block:: python import salt.utils.win_reg winreg.broadcast_change() r i� )�win32guiZSendMessageTimeoutr' ZHWND_BROADCASTZWM_SETTINGCHANGEZSMTO_ABORTIFHUNG�bool)rP �resr r r �broadcast_change s � rU c C sx t | �}t |�}t� }z|j| }W n ty td|� ���w |j| }g }d} z�z!t�||d|�} tt� | �d �D ] } t� | | �} |� | � q=W n\ tj y� } zO| j dkr|tjd| |dd� dd | � d |� �fW Y d} ~ W | r{t�| � S S | j d kr�tjd | |dd� dd | � d |� �fW Y d} ~ W | r�t�| � S S � d} ~ ww W | r�t�| � |S | r�t�| � w w )a� Enumerates the subkeys in a registry key or hive. Args: hive (str): The name of the hive. Can be one of the following: - HKEY_LOCAL_MACHINE or HKLM - HKEY_CURRENT_USER or HKCU - HKEY_USERS or HKU - HKEY_CLASSES_ROOT or HKCR - HKEY_CURRENT_CONFIG or HKCC key (str): The key (looks like a path) to the value name. If a key is not passed, the keys under the hive will be returned. use_32bit_registry (bool): Accesses the 32bit portion of the registry on 64 bit installations. On 32bit machines this is ignored. Returns: list: A list of keys/subkeys under the hive or key. Usage: .. code-block:: python import salt.utils.win_reg winreg.list_keys(hive='HKLM', key='SOFTWARE\Microsoft') r: Nr r; �Cannot find key: %s\%sT��exc_infoF�Cannot find key: �\r< �Access is denied: %s\%s�Access is denied: )r r r( r0 r r- r= r> �range�RegQueryInfoKey� RegEnumKey�appendr@ rA �log�debugr? ) rB rC rD rE rF rG rH rI ZsubkeysrJ �i�subkeyrK r r r � list_keys1 sP " � � � � ����� � �re c C s� t | �}t |�}t� }z|j| }W n ty td|� ���w |j| }d}t� } z�zWt�||d|�}t t� |�d �D ]C} t� || �\} } } | sMd} ||t | �|j | dd�}| tjkridd � | D �|d < n| tjtjfv rxt | �|d < n| |d < | �|� q>W nX tjy� } zK|jd kr�t�d | |� d d| � d|� �fW Y d}~W |r�t�|� S S |jdkr�t�d| |� d d| � d|� �fW Y d}~W |r�t�|� S S � d}~ww W |r�t�|� | S |r�t�|� w w )a8 Enumerates the values in a registry key or hive. .. note:: The ``(Default)`` value will only be returned if it is set, otherwise it will not be returned in the list of values. Args: hive (str): The name of the hive. Can be one of the following: - HKEY_LOCAL_MACHINE or HKLM - HKEY_CURRENT_USER or HKCU - HKEY_USER or HKU - HKEY_CLASSES_ROOT or HKCR - HKEY_CURRENT_CONFIG or HKCC key (str): The key (looks like a path) to the value name. If a key is not passed, the values under the hive will be returned. use_32bit_registry (bool): Accesses the 32bit portion of the registry on 64 bit installations. On 32bit machines this is ignored. Returns: list: A list of values under the hive or key. Usage: .. code-block:: python import salt.utils.win_reg winreg.list_values(hive='HKLM', key='SYSTEM\CurrentControlSet\Services\Tcpip') r: Nr r$ � (Default)T)rB rC rN r) �successc S � g | ]}t |��qS r �r ��.0rc r r r � <listcomp>� � z list_values.<locals>.<listcomp>r r; rV FrY rZ r< r[ r\ )r r r( r0 r r- �listr= r> r] r^ Z RegEnumValuer r+ r' r! r" r r` r@ rA ra rb r? )rB rC rD rE rF rG rH rI rJ �valuesrc rN r r) �valuerK r r r � list_valuesv sj % � � � � � ����� � �rq c C sr t | �}t |�}t |�}|||dddd�}|sd|d< t� }z|j| } W n ty3 td|� ���w |j| } d} z�z�t�| |d| �} zAt�| |�\} } | sW| ddg fv r�|j | |d < | t j krmd d � | D �|d < n| t j t j fv r|t| �|d < n | |d < nd |d< W nE tjy� } z8|jdkr�|du r�d|d < d|d < n |jdkr�d�|||�}t�|� t�|� ||d< d|d< n� W Y d}~nd}~ww W nV tj�y# } zH|jdkr�d|� d|� �}t�|� t�|� ||d< d|d< n"|jdk�rd|� d|� �}t�|� t�|� ||d< d|d< n� W Y d}~nd}~ww W | �r-t�| � |S | �r8t�| � w w )a� Reads a registry value entry or the default value for a key. To read the default value, don't pass ``vname`` Args: hive (str): The name of the hive. Can be one of the following: - HKEY_LOCAL_MACHINE or HKLM - HKEY_CURRENT_USER or HKCU - HKEY_USER or HKU - HKEY_CLASSES_ROOT or HKCR - HKEY_CURRENT_CONFIG or HKCC key (str): The key (looks like a path) to the value name. vname (str): The value name. These are the individual name/data pairs under the key. If not passed, the key (Default) value will be returned. use_32bit_registry (bool): Accesses the 32bit portion of the registry on 64bit installations. On 32bit machines this is ignored. Returns: dict: A dictionary containing the passed settings as well as the value_data if successful. If unsuccessful, sets success to False. bool: Returns False if the key is not found If vname is not passed: - Returns the first unnamed value (Default) as a string. - Returns none if first unnamed value is empty. Usage: The following will get the value of the ``version`` value name in the ``HKEY_LOCAL_MACHINE\\SOFTWARE\\Salt`` key .. code-block:: python import salt.utils.win_reg as reg reg.read_value(hive='HKLM', key='SOFTWARE\\Salt', vname='version') Usage: The following will get the default value of the ``HKEY_LOCAL_MACHINE\\SOFTWARE\\Salt`` key .. code-block:: python import salt.utils.win_reg as reg reg.read_value(hive='HKLM', key='SOFTWARE\\Salt') NT)rB rC rN r r) rg rf rN r: r r r) c S rh r ri rj r r r rl - rm z read_value.<locals>.<listcomp>r z Empty ValueZcommentr; z(value not set)r" zCannot find {} in {}\{}Frg rY rZ r< r\ )r r r( r0 r r- r= r> rM r+ r' r! r" r r r@ rA r2 ra Ztracer? )rB rC rN rD rE rF rO �retrG rH rI rJ r r) rK r4 r r r � read_value� s� =� � � � ��� ��� � �rs r" c C s t | �}t |�}t |�} t |�} t� } z| j| } W n ty( td|� ���w | j| } | j| tjB }t || d�}|rD| j d }n| j d }d}z�z�t j | |||d�\}}|dkr^dnd }t �|||� z t �|| d | |� t �|� t� W W W |r�t �|� d S d S ty� } zt �d |� W Y d}~W W |r�t �|� d S d S d}~w ttfy� } zt �d|� W Y d}~W W |r�t �|� d S d S d}~ww t jy� } z t �d|||j|j� W Y d}~W |r�t �|� d S d S d}~ww |�rt �|� w w )a� Sets a value in the registry. If ``vname`` is passed, it will be the value for that value name, otherwise it will be the default value for the specified key Args: hive (str): The name of the hive. Can be one of the following - HKEY_LOCAL_MACHINE or HKLM - HKEY_CURRENT_USER or HKCU - HKEY_USER or HKU - HKEY_CLASSES_ROOT or HKCR - HKEY_CURRENT_CONFIG or HKCC key (str): The key (looks like a path) to the value name. vname (str): The value name. These are the individual name/data pairs under the key. If not passed, the key (Default) value will be set. vdata (str, int, list, bytes): The value you'd like to set. If a value name (vname) is passed, this will be the data for that value name. If not, this will be the (Default) value for the key. The type of data this parameter expects is determined by the value type specified in ``vtype``. The correspondence is as follows: - REG_BINARY: Binary data (bytes) - REG_DWORD: int - REG_EXPAND_SZ: str - REG_MULTI_SZ: list of str - REG_QWORD: int - REG_SZ: str .. note:: When setting REG_BINARY, string data will be converted to binary. You can pass base64 encoded using the ``binascii`` built-in module. Use ``binascii.b2a_base64('your data')`` .. note:: The type for the (Default) value is always REG_SZ and cannot be changed. .. note:: This parameter is optional. If not passed, the Key will be created with no associated item/value pairs. vtype (str): The value type. The possible values of the vtype parameter are indicated above in the description of the vdata parameter. use_32bit_registry (bool): Sets the 32bit portion of the registry on 64bit installations. On 32bit machines this is ignored. volatile (bool): When this parameter has a value of True, the registry key will be made volatile (i.e. it will not persist beyond a system reset or shutdown). This parameter only has an effect when a key is being created and at no other time. Returns: bool: True if successful, otherwise False Usage: This will set the version value to 2015.5.2 in the SOFTWARE\Salt key in the HKEY_LOCAL_MACHINE hive .. code-block:: python import salt.utils.win_reg winreg.set_value(hive='HKLM', key='SOFTWARE\Salt', vname='version', vdata='2015.5.2') Usage: This function is strict about the type of vdata. For instance this example will fail because vtype has a value of REG_SZ and vdata has a type of int (as opposed to str as expected). .. code-block:: python import salt.utils.win_reg winreg.set_value(hive='HKLM', key='SOFTWARE\Salt', vname='str_data', vdata=1.2) Usage: In this next example vdata is properly quoted and should succeed. .. code-block:: python import salt.utils.win_reg winreg.set_value(hive='HKLM', key='SOFTWARE\Salt', vname='str_data', vdata='1.2') Usage: This is an example of using vtype REG_BINARY. Both ``set_value`` commands will set the same value ``Salty Test`` .. code-block:: python import salt.utils.win_reg winreg.set_value(hive='HKLM', key='SOFTWARE\Salt', vname='bin_data', vdata='Salty Test', vtype='REG_BINARY') import binascii bin_data = binascii.b2a_base64('Salty Test') winreg.set_value(hive='HKLM', key='SOFTWARE\Salt', vname='bin_data_encoded', vdata=bin_data, vtype='REG_BINARY') Usage: An example using vtype REG_MULTI_SZ is as follows: .. code-block:: python import salt.utils.win_reg winreg.set_value(hive='HKLM', key='SOFTWARE\Salt', vname='list_data', vdata=['Salt', 'is', 'great'], vtype='REG_MULTI_SZ') r: )r r) r& r% N)�Optionsr$ zCreated new key: %s\%szOpened existing key: %s\%sr Tz1"vdata" does not match the expected data type. %sFz,Encountered error setting registry value. %sz'Error creating/opening key: %s\%s %s %s)r r r( r0 r r) r- r' �KEY_ALL_ACCESS� cast_vdatar* r= ZRegCreateKeyExra rb Z RegSetValueExZ RegFlushKeyrU r? � TypeError� exception� SystemError� ValueErrorr@ rA �strerror)rB rC rN r r) rD ZvolatilerE rF rO Z local_vtyperG rH � vtype_valuerI Z local_vdataZcreate_optionsrJ �resultr4 rK r r r � set_valueX s� � �� �� ��� ���� ��� �r~ c C s| t � }|j| }|tjtjfv rt| �S |tjkr%t| t�r#| � d�S | S |tj kr1dd� | D �S |tj kr:t | �S t | �S )a Cast the ``vdata` value to the appropriate data type for the registry type specified in ``vtype`` Args: vdata (str, int, list, bytes): The data to cast vtype (str): The type of data to be written to the registry. Must be one of the following: - REG_BINARY - REG_DWORD - REG_EXPAND_SZ - REG_MULTI_SZ - REG_QWORD - REG_SZ Returns: The vdata cast to the appropriate type. Will be unicode string, binary, list of unicode strings, or int Usage: .. code-block:: python import salt.utils.win_reg winreg.cast_vdata(vdata='This is the string', vtype='REG_SZ') r c S rh r )r rj r r r rl D rm z cast_vdata.<locals>.<listcomp>) r r) r' r" r r r r r �encoder! r# r )r r) rG r| r r r rv s # rv c s t | �}t |�}t� }z|j| }W n ty td|� ���w |}|j| tjB �t|||�s:t � d| |� dS t |�dkrT|� dd�|j | k rTt �d| |� dS dd� � � ��fd d ��g }�|||��}|�|� g g d �} |D ]�} d } z{zGt�|| d ��} zt�| d� | d �| � d| � �� W n( ty� } z t j| dd� | d �| � d| � d| � �� W Y d } ~ nd } ~ ww W n* tjy� } z t j| dd� | d �| � d| � d| j� �� W Y d } ~ nd } ~ ww W | r�t�| � qu| r�t�| � w w t� | S )aJ .. versionadded:: 2015.5.4 Delete a registry key to include all subkeys and value/data pairs. Args: hive (str): The name of the hive. Can be one of the following - HKEY_LOCAL_MACHINE or HKLM - HKEY_CURRENT_USER or HKCU - HKEY_USER or HKU - HKEY_CLASSES_ROOT or HKCR - HKEY_CURRENT_CONFIG or HKCC key (str): The key to remove (looks like a path) use_32bit_registry (bool): Deletes the 32bit portion of the registry on 64bit installations. On 32bit machines this is ignored. Returns: dict: A dictionary listing the keys that deleted successfully as well as those that failed to delete. Usage: The following example will remove ``salt`` and all its subkeys from the ``SOFTWARE`` key in ``HKEY_LOCAL_MACHINE``: .. code-block:: python import salt.utils.win_reg winreg.delete_key_recursive(hive='HKLM', key='SOFTWARE\DeleteMe') r: z"%s\%s" not foundFr$ rZ z0"%s\%s" is too close to root, not safe to removec s sD � d} zt �| |�}t|�V |d7 }W n t jy Y dS w q)z Enumerate keys r Tr$ N)r= r_ r r@ )�_keyrc rd r r r �_subkeys� s � ��z&delete_key_recursive.<locals>._subkeysc sH t �| |d|�}� |�D ]}|� d|� �}�| ||��}|�|� q |S )zD Traverse the registry tree i.e. dive into the tree r rZ )r= r> r` )Z_hkeyZ_keypathZ_retZ _access_maskr� Z subkeynameZ subkeypath�r� �_traverse_registry_treerI r r r� � s z5delete_key_recursive.<locals>._traverse_registry_tree)�Deleted�FailedNr r r� TrW r� � )r r r( r0 r r- r' ru rL ra rb �len�countr, r@ r` r= r> Z RegDeleteKey�OSErrorr{ r? rU ) rB rC rD rE rF rG rH Zkey_pathZkey_listrr Z sub_key_pathZ key_handlerK r r� r �delete_key_recursiveM sb ' � " *���,��� �� �r� c C s� t | �}t |�}t |�}t� }z|j| }W n ty$ td|� ���w |j| tjB } d} zCz t� ||d| �} t� | |� t � W W | rMt� | � dS dS tj yr } z| jdkrmW Y d} ~ W | rkt� | � dS dS � d} ~ ww | r{t� | � w w )a Delete a registry value entry or the default value for a key. Args: hive (str): The name of the hive. Can be one of the following - HKEY_LOCAL_MACHINE or HKLM - HKEY_CURRENT_USER or HKCU - HKEY_USER or HKU - HKEY_CLASSES_ROOT or HKCR - HKEY_CURRENT_CONFIG or HKCC key (str): The key (looks like a path) to the value name. vname (str): The value name. These are the individual name/data pairs under the key. If not passed, the key (Default) value will be deleted. use_32bit_registry (bool): Deletes the 32bit portion of the registry on 64bit installations. On 32bit machines this is ignored. Return: bool: True if successful, otherwise False Usage: .. code-block:: python import salt.utils.win_reg winreg.delete_value(hive='HKLM', key='SOFTWARE\SaltTest', vname='version') r: Nr Tr; )r r r( r0 r r- r' ru r= r> ZRegDeleteValuerU r? r@ rA ) rB rC rN rD rE rF rO rG rH rI rJ rK r r r � delete_value� s> $ � �� ���� �r� )F)NF)NNr" FF)Nr" ) r9 �loggingZsalt.utils.platformr Zsalt.utils.stringutilsZsalt.exceptionsr r= r' rR r � ImportError� getLoggerr6 ra r r r r r rL rQ rU re rq rs r~ rv r� r� r r r r �<module> sH � D 1@ E Y � < :s
| ver. 1.4 |
Github
|
.
| PHP 8.2.30 | Generation time: 0 |
proxy
|
phpinfo
|
Settings