202 lines
7.3 KiB
Python
202 lines
7.3 KiB
Python
# Copyright 2018 AT&T Intellectual Property. All other 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.
|
|
|
|
import logging
|
|
|
|
import click
|
|
import yaml
|
|
|
|
from pegleg import config
|
|
from pegleg.engine.util.encryption import decrypt
|
|
from pegleg.engine.util.encryption import encrypt
|
|
from pegleg.engine.util import files
|
|
from pegleg.engine.util.pegleg_managed_document import \
|
|
PeglegManagedSecretsDocument as PeglegManagedSecret
|
|
|
|
LOG = logging.getLogger(__name__)
|
|
|
|
|
|
class PeglegSecretManagement(object):
|
|
"""An object to handle operations on of a pegleg managed file."""
|
|
|
|
def __init__(self,
|
|
file_path=None,
|
|
docs=None,
|
|
generated=False,
|
|
catalog=None,
|
|
author=None,
|
|
site_name=None):
|
|
"""
|
|
Read the source file and the environment data needed to wrap and
|
|
process the file documents as pegleg managed document.
|
|
Either of the ``file_path`` or ``docs`` must be
|
|
provided.
|
|
"""
|
|
|
|
# Set passphrase and salt
|
|
config.set_passphrase()
|
|
config.set_salt()
|
|
|
|
# Check if we're working with a specific site, if so determine if the
|
|
# global encryption keys already exist. If they don't, set them.
|
|
if site_name:
|
|
if not (config.get_global_passphrase()
|
|
and config.get_global_salt()):
|
|
config.set_global_enc_keys(site_name)
|
|
|
|
if all([file_path, docs]) or not any([file_path, docs]):
|
|
raise ValueError('Either `file_path` or `docs` must be '
|
|
'specified.')
|
|
|
|
if generated and not (catalog and author):
|
|
raise ValueError("If the document is generated, author and "
|
|
"catalog must be specified.")
|
|
|
|
self.file_path = file_path
|
|
self.documents = list()
|
|
self._generated = generated
|
|
|
|
if docs:
|
|
for doc in docs:
|
|
self.documents.append(
|
|
PeglegManagedSecret(doc,
|
|
generated=generated,
|
|
catalog=catalog,
|
|
author=author))
|
|
else:
|
|
self.file_path = file_path
|
|
for doc in files.read(file_path):
|
|
self.documents.append(PeglegManagedSecret(doc))
|
|
|
|
self._author = author
|
|
|
|
def __iter__(self):
|
|
"""
|
|
Make the secret management object iterable
|
|
:return: the wrapped documents
|
|
"""
|
|
return (doc.pegleg_document for doc in self.documents)
|
|
|
|
def encrypt_secrets(self, save_path):
|
|
"""
|
|
Wrap and encrypt the secrets documents included in the input file,
|
|
into pegleg manage secrets documents, and write the result in
|
|
save_path.
|
|
|
|
if save_path is the same as the source file_path the encrypted file
|
|
will overwrite the source file.
|
|
|
|
:param save_path: Destination path of the encrypted file
|
|
:type save_path: string
|
|
:param author: Identifier for the program or person who is
|
|
encrypting the secrets documents
|
|
:type author: string
|
|
"""
|
|
|
|
doc_list, encrypted_docs = self.get_encrypted_secrets()
|
|
if encrypted_docs:
|
|
files.write(doc_list, save_path)
|
|
click.echo('Wrote encrypted data to: {}'.format(save_path))
|
|
else:
|
|
LOG.debug('All documents in file: {} are either already encrypted '
|
|
'or have cleartext storage policy. '
|
|
'Skipping.'.format(self.file_path))
|
|
|
|
def get_encrypted_secrets(self):
|
|
"""
|
|
:return doc_list: The list of documents
|
|
:rtype doc_list: list
|
|
:return encrypted_docs: Whether any documents were encrypted
|
|
:rtype encrypted_docs: bool
|
|
"""
|
|
if self._generated and not self._author:
|
|
raise ValueError("An author is needed to encrypt "
|
|
"generated documents. "
|
|
"Specify it when PeglegSecretManagement "
|
|
"is initialized.")
|
|
|
|
encrypted_docs = False
|
|
doc_list = []
|
|
for doc in self.documents:
|
|
# do not re-encrypt already encrypted data
|
|
if doc.is_encrypted():
|
|
doc_list.append(doc.pegleg_document)
|
|
continue
|
|
|
|
# only encrypt if storagePolicy is set to encrypted.
|
|
if not doc.is_storage_policy_encrypted():
|
|
# case documents in a file have different storage
|
|
# policies
|
|
doc_list.append(doc.embedded_document)
|
|
continue
|
|
|
|
# Get appropriate encryption keys to use
|
|
if doc.get_layer() == 'site':
|
|
passphrase = config.get_passphrase()
|
|
salt = config.get_salt()
|
|
else:
|
|
passphrase = config.get_global_passphrase()
|
|
salt = config.get_global_salt()
|
|
|
|
secret_doc = doc.get_secret()
|
|
if type(secret_doc) != bytes:
|
|
secret_doc = secret_doc.encode()
|
|
doc.set_secret(encrypt(secret_doc, passphrase, salt))
|
|
doc.set_encrypted(self._author)
|
|
encrypted_docs = True
|
|
doc_list.append(doc.pegleg_document)
|
|
return doc_list, encrypted_docs
|
|
|
|
def decrypt_secrets(self):
|
|
"""Decrypt and unwrap pegleg managed encrypted secrets documents
|
|
included in a site secrets file, and print the result to the standard
|
|
out."""
|
|
|
|
secrets = self.get_decrypted_secrets()
|
|
|
|
return yaml.safe_dump_all(secrets,
|
|
explicit_start=True,
|
|
explicit_end=True,
|
|
default_flow_style=False)
|
|
|
|
def get_decrypted_secrets(self):
|
|
"""
|
|
Unwrap and decrypt all the pegleg managed documents in a secrets
|
|
file, and return the result as a list of documents.
|
|
|
|
The method is idempotent. If the method is called on not
|
|
encrypted files, or documents inside the file, it will return
|
|
the original unwrapped and unencrypted documents.
|
|
|
|
"""
|
|
|
|
doc_list = []
|
|
for doc in self.documents:
|
|
# do not decrypt already decrypted data
|
|
if doc.is_encrypted():
|
|
|
|
# Get appropriate encryption keys to use
|
|
if doc.get_layer() == 'site':
|
|
passphrase = config.get_passphrase()
|
|
salt = config.get_salt()
|
|
else:
|
|
passphrase = config.get_global_passphrase()
|
|
salt = config.get_global_salt()
|
|
|
|
doc.set_secret(
|
|
decrypt(doc.get_secret(), passphrase, salt).decode())
|
|
doc.set_decrypted()
|
|
doc_list.append(doc.embedded_document)
|
|
return doc_list
|