�
i��d� � �h � d dl Z d dlmZ d dlmZ d dlmZ d dlmZ d dl m
Z
m Z m Z G d� de
e � Z
y) � N)� HTTPResponse)�Any)�request)�URLError)�Plugin�IndependentPlugin� PluginOptc � � e Zd ZdZdZdZ eddd�� gZdZd Z d
Z
d Z d � Z d
� Z
d� Zdefd�Zededefd�� Zd� Zededefd�� Zy)�GCPzGoogle Cloud Platform�gcp)�virt�keep-piiFzyStop the plugin from removing PIIs like project name or organization ID from the metadata retrieved from Metadata server.)�default�descz3http://metadata.google.internal/computeMetadata/v1/zBhttp://metadata.google.internal/computeMetadata/v1/?recursive=truez[--REDACTED--]zDDMI: Google Google Compute Engine/Google Compute Engine, BIOS Googlec �X � | j d� }|d dk7 ry| j |d v S )z�
Checks if this plugin should be executed at all. In this case, it
will check the `dmesg` command output to see if the system is
running on a Google Cloud Compute instance.
�dmesg�statusr F�output)�exec_cmd�
GOOGLE_DMI)�selfr s �8/usr/lib/python3/dist-packages/sos/report/plugins/gcp.py�
check_enabledzGCP.check_enabled( s4 � � �
�
�g�&�� ��?�a� �����%��/�1�1� c �T � | j ddg�� | j ddg�� y)z�
Collect the following info:
* Metadata from the Metadata server
* `gcloud auth list` output
* Any google services output from journal
zgcloud auth listr ��tagszgoogle*)�unitsr N)�add_cmd_output� add_journal)r s r �setupz GCP.setup3 s1 � �
��� .�e�W��=�
���y��w��7r c �b � | j ddg�� 5 } | j � | _ | j � |j t j | j d�� � d d d � y # t $ r$}|j t |� � Y d }~�1d }~ww xY w# 1 sw Y y xY w)Nz
metadata.jsonr r � )�indent) �collection_file� get_metadata�metadata�scrub_metadata�write�json�dumps� RuntimeError�str)r �mfile�errs r �collectz GCP.collectA s� � �
�
!�
!�/���
!�
@� &�E�
&� $� 1� 1� 3��
��#�#�%�� � �D�J�J�t�}�}�Q� ?�@� &� &��
�
&�� � �C��H�%�%��
&�� &� &�s/ �B%�AA5�5 B"�>B �B%� B"�"B%�%B.�returnc � � | j | j � }|j � j � }t j
|� S )zq
Retrieves metadata from the Metadata Server and transforms it into a
dictionary object.
)�_query_address�METADATA_QUERY�read�decoder* �loads)r �response�
response_bodys r r& zGCP.get_metadataK s= � �
�&�&�t�':�':�;�� �
�
��.�.�0�
��z�z�-�(�(r �urlc �B � t j | ddi�� }t j |� }|j dk7 r8t d|j � d�|j � j � z � �|S # t $ r }t dt |� z � �d}~ww xY w) zf
Query the given url address with headers required by Google Metadata
Server.
zMetadata-Flavor�Google)�headersz,Failed to communicate with Metadata Server: N�� z2Failed to communicate with Metadata Server (code: z): ) r �Request�urlopenr r, r- �coder5 r6 )r: �reqr8 r/ s r r3 zGCP._query_addressT s� � � K��/�/�#�0A�8�/L�M�C� ���s�+�H� �=�=�C� � ��"�-�-� ��-�/7�}�}��/E�/E�/G�H�I�
I� ��� � K� �>��S��I�K�
K�� K�s �.A9 �9 B �B�B c �r � ����� � j d� ry� j d d �� j d d �t �� �dt dt f����� fd� � �� j � � _ � j � j d d d
� � j � j d d d � y) a"
Remove all PII information from metadata, unless a keep-pii option
is specified.
Note: PII information collected by this plugin, like
project number, account names etc. might be required by Google
Cloud Support for faster issue resolution.
r N�project� projectId�numericProjectId�datar1 c �� �� t | t � rCd| v r�j | d< | j � D ��ci c] \ }} �|� �|� �� c}}S t | t � r| D �cg c]
} �|� �� c}S t | t
� r6| j
��j � j
��j � S t | t � r| �k( r �j S | S | S c c}}w c c}w )N�token)�
isinstance�dict�REDACTED�items�listr- �replace�int) rG �k�v�value�
project_id�project_number�project_number_int�scrubr s �����r rW z!GCP.scrub_metadata.<locals>.scrubv s� �� ��$��%��d�?� %)�M�M�D��M�7;�z�z�|�D�t�q�!��a��%��(�*�D�D��D�$�'�26�7���e� �7�7��D�#�&��|�|�N�D�M�M�B� #�G�J��
�
� >�?��D�#�&�(,�0B�(B�t�}�}�L��L��K�� E��7s �C&�)C,�
attributeszssh-keys�sshKeys)�
get_optionr' r- r �safe_redact_key)r rT rU rV rW s `@@@@r r( zGCP.scrub_metadataf s� �� � �?�?�:� &� ��]�]�9�-�k�:�
� !�]�]�9� 5�6H� I�� � /�0�� �� �� � � �d�m�m�,��
� � � �T�]�]�9� 5�l� C� '� )� � � �T�]�]�9� 5�l� C� &� (r �dict_obj�keyc �, � ||v r| j ||< y y )N)rL )�clsr\ r] s r r[ zGCP.safe_redact_key� s � � �(�?� �L�L�H�S�M� r N)�__name__�
__module__� __qualname__�
short_desc� plugin_name�profilesr � option_list�
METADATA_ROOTr4 rL r r r! r0 rK r& � staticmethodr- r r3 r( � classmethodr[ � r r r r s� � �(�J��K��H� �*�e�*� +��K� J�M�'�N� �H�/�J� 2� 8� &�)�d� )� ��C� �L� � ��"%(�N �)�t� )�#� )� �)r r )r* � http.clientr �typingr �urllibr � urllib.errorr �sos.report.pluginsr r r r rj r r �<module>rp s- �� � $� � � !� C� C�)�&�#� )r |