172 lines
6.3 KiB
Python
172 lines
6.3 KiB
Python
# -*- coding: utf-8 -*- #
|
|
# Copyright 2019 Google LLC. All Rights Reserved.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
"""Access a secret version's data."""
|
|
|
|
from __future__ import absolute_import
|
|
from __future__ import division
|
|
from __future__ import unicode_literals
|
|
|
|
from googlecloudsdk.api_lib.secrets import api as secrets_api
|
|
from googlecloudsdk.api_lib.util import exceptions
|
|
from googlecloudsdk.calliope import base
|
|
from googlecloudsdk.calliope import exceptions as calliope_exceptions
|
|
from googlecloudsdk.calliope import parser_arguments
|
|
from googlecloudsdk.calliope import parser_extensions
|
|
from googlecloudsdk.command_lib.secrets import args as secrets_args
|
|
from googlecloudsdk.command_lib.secrets import fmt as secrets_fmt
|
|
from googlecloudsdk.command_lib.secrets import util as secrets_util
|
|
from googlecloudsdk.command_lib.util import crc32c
|
|
|
|
|
|
CHECKSUM_VERIFICATION_FAILURE_MESSAGE = (
|
|
'An incorrect data_crc32c was calculated for the provided payload. This '
|
|
'might be a transient issue that resolves with a retry. If this is '
|
|
'happening repeatedly open an issue with Secret Manager at '
|
|
'https://issuetracker.google.com/issues/new?component=784854&template=1380926.'
|
|
)
|
|
|
|
|
|
@base.DefaultUniverseOnly
|
|
@base.ReleaseTracks(base.ReleaseTrack.GA)
|
|
class Access(base.DescribeCommand):
|
|
# pylint: disable=line-too-long
|
|
r"""Access a secret version's data.
|
|
|
|
Access the data for the specified secret version.
|
|
|
|
## EXAMPLES
|
|
|
|
Access the data for version 123 of the secret 'my-secret':
|
|
|
|
$ {command} 123 --secret=my-secret
|
|
|
|
Note: The output will be formatted as UTF-8 which can corrupt binary secrets.
|
|
|
|
To write raw bytes to a file use --out-file flag:
|
|
|
|
$ {command} 123 --secret=my-secret --out-file=/tmp/secret
|
|
|
|
To get the raw bytes, have Google Cloud CLI print the response as
|
|
base64-encoded and decode:
|
|
|
|
$ {command} 123 --secret=my-secret --format='get(payload.data)' | tr '_-' '/+' | base64 -d
|
|
"""
|
|
EMPTY_OUT_FILE_MESSAGE = (
|
|
'The value provided for --out-file is the empty string. This can happen '
|
|
'if you pass or pipe a variable that is undefined. Please verify that '
|
|
'the --out-file flag is not the empty string.')
|
|
# pylint: enable=line-too-long
|
|
|
|
@staticmethod
|
|
def Args(parser: parser_arguments.ArgumentInterceptor):
|
|
"""Args is called by calliope to gather arguments for secrets versions access command.
|
|
|
|
Args:
|
|
parser: An argparse parser that you can use to add arguments that will be
|
|
available to this command.
|
|
"""
|
|
secrets_args.AddVersionOrAlias(
|
|
parser, purpose='to access', positional=True, required=True
|
|
)
|
|
secrets_args.AddLocation(parser, purpose='to access secret', hidden=False)
|
|
secrets_args.AddOutFile(parser)
|
|
secrets_fmt.UseSecretData(parser)
|
|
|
|
def Run(self, args: parser_extensions.Namespace) -> secrets_api.Versions:
|
|
"""Run is called by calliope to implement the secret versions access command.
|
|
|
|
Args:
|
|
args: an argparse namespace, all the arguments that were provided to this
|
|
command invocation.
|
|
|
|
Returns:
|
|
API call to invoke secret version access.
|
|
"""
|
|
api_version = secrets_api.GetApiFromTrack(self.ReleaseTrack())
|
|
version_ref = args.CONCEPTS.version.Parse()
|
|
version = secrets_api.Versions(api_version=api_version).Access(
|
|
version_ref, secret_location=args.location
|
|
)
|
|
if version.payload.dataCrc32c is None or crc32c.does_data_match_checksum(
|
|
version.payload.data, version.payload.dataCrc32c
|
|
):
|
|
if args.IsSpecified('out_file'):
|
|
if not args.out_file:
|
|
raise calliope_exceptions.BadFileException(
|
|
self.EMPTY_OUT_FILE_MESSAGE)
|
|
# if flag --out-file is provided use the 'disable'
|
|
# format from go/gcloud-ref/topic/formats
|
|
args.format = 'disable'
|
|
secrets_util.WriteBinaryFile(args.out_file, version.payload.data)
|
|
return version
|
|
raise exceptions.HttpException(CHECKSUM_VERIFICATION_FAILURE_MESSAGE)
|
|
|
|
|
|
@base.DefaultUniverseOnly
|
|
@base.ReleaseTracks(base.ReleaseTrack.BETA)
|
|
class AccessBeta(Access):
|
|
# pylint: disable=line-too-long
|
|
r"""Access a secret version's data.
|
|
|
|
Access the data for the specified secret version.
|
|
|
|
## EXAMPLES
|
|
|
|
Access the data for version 123 of the secret 'my-secret':
|
|
|
|
$ {command} 123 --secret=my-secret
|
|
|
|
Note: The output will be formatted as UTF-8 which can corrupt binary secrets.
|
|
|
|
To write raw bytes to a file use --out-file flag:
|
|
|
|
$ {command} 123 --secret=my-secret --out-file=/tmp/secret
|
|
|
|
To get the raw bytes, have Google Cloud CLI print the response as
|
|
base64-encoded and decode:
|
|
|
|
$ {command} 123 --secret=my-secret --format='get(payload.data)' | tr '_-' '/+' | base64 -d
|
|
"""
|
|
# pylint: enable=line-too-long
|
|
|
|
@staticmethod
|
|
def Args(parser):
|
|
secrets_args.AddVersionOrAlias(
|
|
parser, purpose='to access', positional=True, required=True
|
|
)
|
|
secrets_args.AddLocation(parser, purpose='to access secret', hidden=False)
|
|
secrets_args.AddOutFile(parser)
|
|
secrets_fmt.UseSecretData(parser)
|
|
|
|
def Run(self, args):
|
|
api_version = secrets_api.GetApiFromTrack(self.ReleaseTrack())
|
|
version_ref = args.CONCEPTS.version.Parse()
|
|
version = secrets_api.Versions(api_version=api_version).Access(
|
|
version_ref, secret_location=args.location
|
|
)
|
|
if version.payload.dataCrc32c is None or crc32c.does_data_match_checksum(
|
|
version.payload.data, version.payload.dataCrc32c
|
|
):
|
|
if args.IsSpecified('out_file'):
|
|
if not args.out_file:
|
|
raise calliope_exceptions.BadFileException(
|
|
self.EMPTY_OUT_FILE_MESSAGE)
|
|
# if flag --out-file is provided use the 'disable'
|
|
# format from go/gcloud-ref/topic/formats
|
|
args.format = 'disable'
|
|
secrets_util.WriteBinaryFile(args.out_file, version.payload.data)
|
|
return version
|
|
raise exceptions.HttpException(CHECKSUM_VERIFICATION_FAILURE_MESSAGE)
|