]'dZddlmZddlmZddlmZddlZddlmZddlmZddl m Z ddl mZ dd l mZdd lmZddlZGd d ej$Zd ZdZdZdZddZ ddZdZ ddZddZy)z0Convenience functions for dealing with metadata.)absolute_import)division)unicode_literalsN) constants) exceptions) arg_parsers)log)filesceZdZdZy)InvalidSshKeyExceptionz:InvalidSshKeyException is for invalid ssh keys in metadataN)__name__ __module__ __qualname____doc__4lib/googlecloudsdk/api_lib/compute/metadata_utils.pyr r !sBrr c|j}|r\ttj|D];\}}|jj |jj ||=|S)z/Converts a metadata dict to a Metadata message.)keyvalue)Metadatasortedsix iteritemsitemsappendItemsValueListEntry)message_classes metadata_dictmessagerrs r_DictToMetadataMessager!%sg  $ $ &'S]]=9: U mm?33GGH; .rcbi}|r*|jD]}|j||j<|S)z&Converts a Metadata message to a dict.)rrr)metadata_messageresitems r_MetadataMessageToDictr&0s0 # &&jjc$((m' *rc|jtjd}|jtjd}dj ||f}d|vr t d|j d}g}|D]"}|st|s|j|$|r-d}|jdj |}t |y)a Validates the ssh-key entries in metadata. The ssh-key entry in metadata should start with and it cannot be a private key (i.e. :ssh-rsa @ or :ssh-rsa google-ssh {"userName": @, "expireOn": } when the key can expire.) Args: metadata_dict: A dictionary object containing metadata. Raises: InvalidSshKeyException: If the at the front is missing or private key(s) are detected.  z PRIVATE KEYzHPrivate key(s) are detected. Note that only public keys should be added.zThe following key(s) are missing the at the front {} Format ssh keys following https://cloud.google.com/compute/docs/instances/adding-removing-ssh-keysN) getrSSH_KEYS_METADATA_KEYSSH_KEYS_LEGACY_METADATA_KEYjoinr split_SshKeyStartsWithKeyTyperformat) rssh_keysssh_keys_legacyssh_keys_combinedkeyskeys_missing_usernamerr message_contents r_ValidateSshKeysr79s$  y>> C(!%%i&L&L&(*/ii? ;<''      &$ c ',""3'4G nnTYY/D%EFO  11rcztjDcgc]}|j|}}t|Scc}w)zChecks if the key starts with any key type in constants.SSH_KEY_TYPES. Args: key: A ssh key in metadata. Returns: True if the key starts with any key type in constants.SSH_KEY_TYPES, returns false otherwise. )r SSH_KEY_TYPES startswithany)rkey_typekey_starts_with_typess rr/r/esC09/F/F/F8cnnX/F " ##s8c|xsi}|xsi}tj|}tj|D]E\}}||vr$t j dj |tj|||<G|S)aReturns the dict of metadata key:value pairs based on the given dicts. Args: metadata: A dict mapping metadata keys to metadata values or None. metadata_from_file: A dict mapping metadata keys to file names containing the keys' values or None. Raises: ToolException: If metadata and metadata_from_file contain duplicate keys or if there is a problem reading the contents of a file in metadata_from_file. Returns: A dict of metadata key:value pairs. z)Encountered duplicate metadata key [{0}].) copydeepcopyrrcompute_exceptionsDuplicateErrorr0r ReadFileContents)metadatametadata_from_filenew_metadata_dictr file_paths rConstructMetadataDictrHvs ^()/RmmH- &89nc9   - - 5 < c : rct||}t|}|j| t|t||}|r|j|_|S#t$r}t j |Yd}~Dd}~wwxYw)aCreates a Metadata message from the given dicts of metadata. Args: message_classes: An object containing API message classes. metadata: A dict mapping metadata keys to metadata values or None. metadata_from_file: A dict mapping metadata keys to file names containing the keys' values or None. existing_metadata: If not None, the given metadata values are combined with this Metadata message. Raises: ToolException: If metadata and metadata_from_file contain duplicate keys or if there is a problem reading the contents of a file in metadata_from_file. Returns: A Metadata protobuf. N) rHr&updater7r r warningr! fingerprint)rrDrEexisting_metadatarFexisting_metadata_dictenew_metadata_messages rConstructMetadataMessagerQs,,H6HI12CD 12+,00FH'8'D'D$  KKNNs A A>A99A>c0t|t|k(S)zEReturns True if both metadata messages have the same key/value pairs.)r&) metadata1 metadata2s r MetadataEqualrUs  *.DY.O OOrc|r|j}n2|r0t|}|D]}|j|dt||}|j_|S)aRemoves keys from existing_metadata. Args: message_classes: An object containing API message classes. existing_metadata: The Metadata message to remove keys from. keys: The keys to remove. This can be None if remove_all is True. remove_all: If True, all entries from existing_metadata are removed. Returns: A new Metadata message with entries removed and the same fingerprint as existing_metadata if existing_metadata contains a fingerprint. N)rr&popr!rL)rrMr4 remove_allrPrNrs r RemoveEntriesrYsg *335 34EF  d+1/1&7%B%B" rcd}|r|dz }|jdtjdi|dtjd}|r|dz }|jd tjdi|d y ) z/Adds --metadata and --metadata-from-file flags.aK Metadata to be made available to the guest operating system running on the instances. Each metadata entry is a key/value pair separated by an equals sign. Each metadata key must be unique and have a max of 128 bytes in length. Each value must have a max of 256 KB in length. Multiple arguments can be passed to this flag, e.g., ``--metadata key-1=value-1,key-2=value-2,key-3=value-3''. The combined total size for all metadata entries is 512 KB. In images that have Compute Engine tools installed on them, such as the link:https://cloud.google.com/compute/docs/images[official images], the following metadata keys have special meanings: *startup-script*::: Specifies a script that will be executed by the instances once they start running. For convenience, ``--metadata-from-file'' can be used to pull the value from a file. *startup-script-url*::: Same as ``startup-script'' except that the script contents are pulled from a publicly-accessible location on the web. For startup scripts on Windows instances, the following metadata keys have special meanings: ``windows-startup-script-url'', ``windows-startup-script-cmd'', ``windows-startup-script-bat'', ``windows-startup-script-ps1'', ``sysprep-specialize-script-url'', ``sysprep-specialize-script-cmd'', ``sysprep-specialize-script-bat'', and ``sysprep-specialize-script-ps1''. For more information, see [Running startup scripts](https://cloud.google.com/compute/docs/startupscript). zR At least one of [--metadata] or [--metadata-from-file] is required. z --metadata) min_lengthz KEY=VALUE)typedefaulthelpmetavaractionz Same as ``--metadata'' except that the value for the entry will be read from a local file. This is useful for values that are too large such as ``startup-script'' contents. z--metadata-from-filezKEY=LOCAL_FILE_PATH)r]r^r_r`N) add_argumentrArgDictStoreOnceAction)parserrequired metadata_helpmetadata_from_file_helps rAddMetadataArgsris! -D  M    ! ,   ( ( *        ! , "# %r)NN)NNN)NF)F)r __future__rrrr?googlecloudsdk.api_lib.computerrgooglecloudsdk.callioper"googlecloudsdk.command_lib.computerAgooglecloudsdk.corer googlecloudsdk.core.utilr rErrorr r!r&r7r/rHrQrUrYrirrrrqs7&' 45/O#* CZ--C )2X$":'+04/3%PP ).<>%r