mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
e396d5d508
Make !vault-encrypted create a AnsibleVaultUnicode
yaml object that can be used as a regular string object.
This allows a playbook to include a encrypted vault
blob for the value of a yaml variable. A 'secret_password'
variable can have it's value encrypted instead of having
to vault encrypt an entire vars file.
Add __ENCRYPTED__ to the vault yaml types so
template.Template can treat it similar
to __UNSAFE__ flags.
vault.VaultLib api changes:
- Split VaultLib.encrypt to encrypt and encrypt_bytestring
- VaultLib.encrypt() previously accepted the plaintext data
as either a byte string or a unicode string.
Doing the right thing based on the input type would fail
on py3 if given a arg of type 'bytes'. To simplify the
API, vaultlib.encrypt() now assumes input plaintext is a
py2 unicode or py3 str. It will encode to utf-8 then call
the new encrypt_bytestring(). The new methods are less
ambiguous.
- moved VaultLib.is_encrypted logic to vault module scope
and split to is_encrypted() and is_encrypted_file().
Add a test/unit/mock/yaml_helper.py
It has some helpers for testing parsing/yaml
Integration tests added as roles test_vault and test_vault_embedded
129 lines
4.2 KiB
Python
129 lines
4.2 KiB
Python
# This file is part of Ansible
|
|
#
|
|
# Ansible is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# Ansible is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
|
#
|
|
# Copyright 2016, Adrian Likins <alikins@redhat.com>
|
|
|
|
# Make coding more python3-ish
|
|
from __future__ import (absolute_import, division, print_function)
|
|
__metaclass__ = type
|
|
|
|
from ansible.compat.tests import unittest
|
|
|
|
|
|
from ansible.parsing import vault
|
|
from ansible.parsing.yaml.loader import AnsibleLoader
|
|
|
|
# module under test
|
|
from ansible.parsing.yaml import objects
|
|
|
|
from units.mock.yaml_helper import YamlTestUtils
|
|
|
|
|
|
class TestAnsibleVaultUnicodeNoVault(unittest.TestCase, YamlTestUtils):
|
|
def test_empty_init(self):
|
|
self.assertRaises(TypeError, objects.AnsibleVaultEncryptedUnicode)
|
|
|
|
def test_empty_string_init(self):
|
|
seq = ''.encode('utf8')
|
|
self.assert_values(seq)
|
|
|
|
def test_empty_byte_string_init(self):
|
|
seq = b''
|
|
self.assert_values(seq)
|
|
|
|
def _assert_values(self, avu, seq):
|
|
self.assertIsInstance(avu, objects.AnsibleVaultEncryptedUnicode)
|
|
self.assertTrue(avu.vault is None)
|
|
# AnsibleVaultEncryptedUnicode without a vault should never == any string
|
|
self.assertNotEquals(avu, seq)
|
|
|
|
def assert_values(self, seq):
|
|
avu = objects.AnsibleVaultEncryptedUnicode(seq)
|
|
self._assert_values(avu, seq)
|
|
|
|
def test_single_char(self):
|
|
seq = 'a'.encode('utf8')
|
|
self.assert_values(seq)
|
|
|
|
def test_string(self):
|
|
seq = 'some letters'
|
|
self.assert_values(seq)
|
|
|
|
def test_byte_string(self):
|
|
seq = 'some letters'.encode('utf8')
|
|
self.assert_values(seq)
|
|
|
|
|
|
class TestAnsibleVaultEncryptedUnicode(unittest.TestCase, YamlTestUtils):
|
|
def setUp(self):
|
|
self.vault_password = "hunter42"
|
|
self.good_vault = vault.VaultLib(self.vault_password)
|
|
|
|
self.wrong_vault_password = 'not-hunter42'
|
|
self.wrong_vault = vault.VaultLib(self.wrong_vault_password)
|
|
|
|
self.vault = self.good_vault
|
|
|
|
def _loader(self, stream):
|
|
return AnsibleLoader(stream, vault_password=self.vault_password)
|
|
|
|
def test_dump_load_cycle(self):
|
|
aveu = self._from_plaintext('the test string for TestAnsibleVaultEncryptedUnicode.test_dump_load_cycle')
|
|
self._dump_load_cycle(aveu)
|
|
|
|
def assert_values(self, avu, seq):
|
|
self.assertIsInstance(avu, objects.AnsibleVaultEncryptedUnicode)
|
|
|
|
self.assertEquals(avu, seq)
|
|
self.assertTrue(avu.vault is self.vault)
|
|
self.assertIsInstance(avu.vault, vault.VaultLib)
|
|
|
|
def _from_plaintext(self, seq):
|
|
return objects.AnsibleVaultEncryptedUnicode.from_plaintext(seq, vault=self.vault)
|
|
|
|
def _from_ciphertext(self, ciphertext):
|
|
avu = objects.AnsibleVaultEncryptedUnicode(ciphertext)
|
|
avu.vault = self.vault
|
|
return avu
|
|
|
|
def test_empty_init(self):
|
|
self.assertRaises(TypeError, objects.AnsibleVaultEncryptedUnicode)
|
|
|
|
def test_empty_string_init_from_plaintext(self):
|
|
seq = ''
|
|
avu = self._from_plaintext(seq)
|
|
self.assert_values(avu,seq)
|
|
|
|
def test_empty_unicode_init_from_plaintext(self):
|
|
seq = u''
|
|
avu = self._from_plaintext(seq)
|
|
self.assert_values(avu,seq)
|
|
|
|
def test_string_from_plaintext(self):
|
|
seq = 'some letters'
|
|
avu = self._from_plaintext(seq)
|
|
self.assert_values(avu,seq)
|
|
|
|
def test_unicode_from_plaintext(self):
|
|
seq = u'some letters'
|
|
avu = self._from_plaintext(seq)
|
|
self.assert_values(avu,seq)
|
|
|
|
# TODO/FIXME: make sure bad password fails differently than 'thats not encrypted'
|
|
def test_empty_string_wrong_password(self):
|
|
seq = ''
|
|
self.vault = self.wrong_vault
|
|
avu = self._from_plaintext(seq)
|
|
self.assert_values(avu, seq)
|