salt/tests/unit/test_crypt.py

# coding: utf-8

# python libs
from __future__ import absolute_import

import os
import shutil
import tempfile

import pytest
import salt.utils.files
from salt import crypt

# salt libs
from salt.ext import six
from tests.support.mock import MagicMock, MockCall, mock_open, patch

# salt testing libs
from tests.support.unit import TestCase, skipIf

# third-party libs
try:
    import M2Crypto

    HAS_M2 = True
except ImportError:
    HAS_M2 = False
try:
    from Cryptodome.PublicKey import RSA  # pylint: disable=unused-import

    HAS_PYCRYPTO_RSA = True
except ImportError:
    HAS_PYCRYPTO_RSA = False
if not HAS_PYCRYPTO_RSA:
    try:
        from Crypto.PublicKey import RSA

        HAS_PYCRYPTO_RSA = True
    except ImportError:
        HAS_PYCRYPTO_RSA = False


PRIVKEY_DATA = (
    "-----BEGIN RSA PRIVATE KEY-----\n"
    "MIIEpAIBAAKCAQEA75GR6ZTv5JOv90Vq8tKhKC7YQnhDIo2hM0HVziTEk5R4UQBW\n"
    "a0CKytFMbTONY2msEDwX9iA0x7F5Lgj0X8eD4ZMsYqLzqjWMekLC8bjhxc+EuPo9\n"
    "Dygu3mJ2VgRC7XhlFpmdo5NN8J2E7B/CNB3R4hOcMMZNZdi0xLtFoTfwU61UPfFX\n"
    "14mV2laqLbvDEfQLJhUTDeFFV8EN5Z4H1ttLP3sMXJvc3EvM0JiDVj4l1TWFUHHz\n"
    "eFgCA1Im0lv8i7PFrgW7nyMfK9uDSsUmIp7k6ai4tVzwkTmV5PsriP1ju88Lo3MB\n"
    "4/sUmDv/JmlZ9YyzTO3Po8Uz3Aeq9HJWyBWHAQIDAQABAoIBAGOzBzBYZUWRGOgl\n"
    "IY8QjTT12dY/ymC05GM6gMobjxuD7FZ5d32HDLu/QrknfS3kKlFPUQGDAbQhbbb0\n"
    "zw6VL5NO9mfOPO2W/3FaG1sRgBQcerWonoSSSn8OJwVBHMFLG3a+U1Zh1UvPoiPK\n"
    "S734swIM+zFpNYivGPvOm/muF/waFf8tF/47t1cwt/JGXYQnkG/P7z0vp47Irpsb\n"
    "Yjw7vPe4BnbY6SppSxscW3KoV7GtJLFKIxAXbxsuJMF/rYe3O3w2VKJ1Sug1VDJl\n"
    "/GytwAkSUer84WwP2b07Wn4c5pCnmLslMgXCLkENgi1NnJMhYVOnckxGDZk54hqP\n"
    "9RbLnkkCgYEA/yKuWEvgdzYRYkqpzB0l9ka7Y00CV4Dha9Of6GjQi9i4VCJ/UFVr\n"
    "UlhTo5y0ZzpcDAPcoZf5CFZsD90a/BpQ3YTtdln2MMCL/Kr3QFmetkmDrt+3wYnX\n"
    "sKESfsa2nZdOATRpl1antpwyD4RzsAeOPwBiACj4fkq5iZJBSI0bxrMCgYEA8GFi\n"
    "qAjgKh81/Uai6KWTOW2kX02LEMVRrnZLQ9VPPLGid4KZDDk1/dEfxjjkcyOxX1Ux\n"
    "Klu4W8ZEdZyzPcJrfk7PdopfGOfrhWzkREK9C40H7ou/1jUecq/STPfSOmxh3Y+D\n"
    "ifMNO6z4sQAHx8VaHaxVsJ7SGR/spr0pkZL+NXsCgYEA84rIgBKWB1W+TGRXJzdf\n"
    "yHIGaCjXpm2pQMN3LmP3RrcuZWm0vBt94dHcrR5l+u/zc6iwEDTAjJvqdU4rdyEr\n"
    "tfkwr7v6TNlQB3WvpWanIPyVzfVSNFX/ZWSsAgZvxYjr9ixw6vzWBXOeOb/Gqu7b\n"
    "cvpLkjmJ0wxDhbXtyXKhZA8CgYBZyvcQb+hUs732M4mtQBSD0kohc5TsGdlOQ1AQ\n"
    "McFcmbpnzDghkclyW8jzwdLMk9uxEeDAwuxWE/UEvhlSi6qdzxC+Zifp5NBc0fVe\n"
    "7lMx2mfJGxj5CnSqQLVdHQHB4zSXkAGB6XHbBd0MOUeuvzDPfs2voVQ4IG3FR0oc\n"
    "3/znuwKBgQChZGH3McQcxmLA28aUwOVbWssfXKdDCsiJO+PEXXlL0maO3SbnFn+Q\n"
    "Tyf8oHI5cdP7AbwDSx9bUfRPjg9dKKmATBFr2bn216pjGxK0OjYOCntFTVr0psRB\n"
    "CrKg52Qrq71/2l4V2NLQZU40Dr1bN9V+Ftd9L0pvpCAEAWpIbLXGDw==\n"
    "-----END RSA PRIVATE KEY-----"
)

PUBKEY_DATA = (
    "-----BEGIN PUBLIC KEY-----\n"
    "MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA75GR6ZTv5JOv90Vq8tKh\n"
    "KC7YQnhDIo2hM0HVziTEk5R4UQBWa0CKytFMbTONY2msEDwX9iA0x7F5Lgj0X8eD\n"
    "4ZMsYqLzqjWMekLC8bjhxc+EuPo9Dygu3mJ2VgRC7XhlFpmdo5NN8J2E7B/CNB3R\n"
    "4hOcMMZNZdi0xLtFoTfwU61UPfFX14mV2laqLbvDEfQLJhUTDeFFV8EN5Z4H1ttL\n"
    "P3sMXJvc3EvM0JiDVj4l1TWFUHHzeFgCA1Im0lv8i7PFrgW7nyMfK9uDSsUmIp7k\n"
    "6ai4tVzwkTmV5PsriP1ju88Lo3MB4/sUmDv/JmlZ9YyzTO3Po8Uz3Aeq9HJWyBWH\n"
    "AQIDAQAB\n"
    "-----END PUBLIC KEY-----"
)

MSG = b"It's me, Mario"

SIG = (
    b"\x07\xf3\xb1\xe7\xdb\x06\xf4_\xe2\xdc\xcb!F\xfb\xbex{W\x1d\xe4E"
    b"\xd3\r\xc5\x90\xca(\x05\x1d\x99\x8b\x1aug\x9f\x95>\x94\x7f\xe3+"
    b"\x12\xfa\x9c\xd4\xb8\x02]\x0e\xa5\xa3LL\xc3\xa2\x8f+\x83Z\x1b\x17"
    b'\xbfT\xd3\xc7\xfd\x0b\xf4\xd7J\xfe^\x86q"I\xa3x\xbc\xd3$\xe9M<\xe1'
    b"\x07\xad\xf2_\x9f\xfa\xf7g(~\xd8\xf5\xe7\xda-\xa3Ko\xfc.\x99\xcf"
    b"\x9b\xb9\xc1U\x97\x82'\xcb\xc6\x08\xaa\xa0\xe4\xd0\xc1+\xfc\x86"
    b'\r\xe4y\xb1#\xd3\x1dS\x96D28\xc4\xd5\r\xd4\x98\x1a44"\xd7\xc2\xb4'
    b"]\xa7\x0f\xa7Db\x85G\x8c\xd6\x94!\x8af1O\xf6g\xd7\x03\xfd\xb3\xbc"
    b"\xce\x9f\xe7\x015\xb8\x1d]AHK\xa0\x14m\xda=O\xa7\xde\xf2\xff\x9b"
    b"\x8e\x83\xc8j\x11\x1a\x98\x85\xde\xc5\x91\x07\x84!\x12^4\xcb\xa8"
    b"\x98\x8a\x8a&#\xb9(#?\x80\x15\x9eW\xb5\x12\xd1\x95S\xf2<G\xeb\xf1"
    b"\x14H\xb2\xc4>\xc3A\xed\x86x~\xcfU\xd5Q\xfe~\x10\xd2\x9b"
)


@skipIf(not HAS_PYCRYPTO_RSA, "pycrypto >= 2.6 is not available")
@skipIf(HAS_M2, "m2crypto is used by salt.crypt if installed")
class CryptTestCase(TestCase):
    @pytest.mark.slow_test(seconds=5)  # Test takes >1 and <=5 seconds
    def test_gen_keys(self):
        open_priv_wb = MockCall("/keydir{0}keyname.pem".format(os.sep), "wb+")
        open_pub_wb = MockCall("/keydir{0}keyname.pub".format(os.sep), "wb+")

        with patch.multiple(
            os,
            umask=MagicMock(),
            chmod=MagicMock(),
            access=MagicMock(return_value=True),
        ):
            with patch("salt.utils.files.fopen", mock_open()) as m_open, patch(
                "os.path.isfile", return_value=True
            ):
                result = crypt.gen_keys("/keydir", "keyname", 2048)
                assert result == "/keydir{0}keyname.pem".format(os.sep), result
                assert open_priv_wb not in m_open.calls
                assert open_pub_wb not in m_open.calls

            with patch("salt.utils.files.fopen", mock_open()) as m_open, patch(
                "os.path.isfile", return_value=False
            ):
                crypt.gen_keys("/keydir", "keyname", 2048)
                assert open_priv_wb in m_open.calls
                assert open_pub_wb in m_open.calls

    @patch("os.umask", MagicMock())
    @patch("os.chmod", MagicMock())
    @patch("os.chown", MagicMock(), create=True)
    @patch("os.access", MagicMock(return_value=True))
    @pytest.mark.slow_test(seconds=5)  # Test takes >1 and <=5 seconds
    def test_gen_keys_with_passphrase(self):
        key_path = os.path.join(os.sep, "keydir")
        open_priv_wb = MockCall(os.path.join(key_path, "keyname.pem"), "wb+")
        open_pub_wb = MockCall(os.path.join(key_path, "keyname.pub"), "wb+")

        with patch("salt.utils.files.fopen", mock_open()) as m_open, patch(
            "os.path.isfile", return_value=True
        ):
            self.assertEqual(
                crypt.gen_keys(key_path, "keyname", 2048, passphrase="password"),
                os.path.join(key_path, "keyname.pem"),
            )
            result = crypt.gen_keys(key_path, "keyname", 2048, passphrase="password")
            assert result == os.path.join(key_path, "keyname.pem"), result
            assert open_priv_wb not in m_open.calls
            assert open_pub_wb not in m_open.calls

        with patch("salt.utils.files.fopen", mock_open()) as m_open, patch(
            "os.path.isfile", return_value=False
        ):
            crypt.gen_keys(key_path, "keyname", 2048)
            assert open_priv_wb in m_open.calls
            assert open_pub_wb in m_open.calls

    @pytest.mark.slow_test(seconds=1)  # Test takes >0.1 and <=1 seconds
    def test_sign_message(self):
        key = RSA.importKey(PRIVKEY_DATA)
        with patch("salt.crypt.get_rsa_key", return_value=key):
            self.assertEqual(SIG, salt.crypt.sign_message("/keydir/keyname.pem", MSG))

    def test_sign_message_with_passphrase(self):
        key = RSA.importKey(PRIVKEY_DATA)
        with patch("salt.crypt.get_rsa_key", return_value=key):
            self.assertEqual(
                SIG,
                crypt.sign_message("/keydir/keyname.pem", MSG, passphrase="password"),
            )

    def test_verify_signature(self):
        with patch("salt.utils.files.fopen", mock_open(read_data=PUBKEY_DATA)):
            self.assertTrue(crypt.verify_signature("/keydir/keyname.pub", MSG, SIG))


@skipIf(not HAS_M2, "m2crypto is not available")
class M2CryptTestCase(TestCase):
    @patch("os.umask", MagicMock())
    @patch("os.chmod", MagicMock())
    @patch("os.access", MagicMock(return_value=True))
    @pytest.mark.slow_test(seconds=1)  # Test takes >0.1 and <=1 seconds
    def test_gen_keys(self):
        with patch("M2Crypto.RSA.RSA.save_pem", MagicMock()) as save_pem:
            with patch("M2Crypto.RSA.RSA.save_pub_key", MagicMock()) as save_pub:
                with patch("os.path.isfile", return_value=True):
                    self.assertEqual(
                        crypt.gen_keys("/keydir", "keyname", 2048),
                        "/keydir{0}keyname.pem".format(os.sep),
                    )
                    save_pem.assert_not_called()
                    save_pub.assert_not_called()

                with patch("os.path.isfile", return_value=False):
                    self.assertEqual(
                        crypt.gen_keys("/keydir", "keyname", 2048),
                        "/keydir{0}keyname.pem".format(os.sep),
                    )
                    save_pem.assert_called_once_with(
                        "/keydir{0}keyname.pem".format(os.sep), cipher=None
                    )
                    save_pub.assert_called_once_with(
                        "/keydir{0}keyname.pub".format(os.sep)
                    )

    @patch("os.umask", MagicMock())
    @patch("os.chmod", MagicMock())
    @patch("os.chown", MagicMock())
    @patch("os.access", MagicMock(return_value=True))
    @pytest.mark.slow_test(seconds=1)  # Test takes >0.1 and <=1 seconds
    def test_gen_keys_with_passphrase(self):
        with patch("M2Crypto.RSA.RSA.save_pem", MagicMock()) as save_pem:
            with patch("M2Crypto.RSA.RSA.save_pub_key", MagicMock()) as save_pub:
                with patch("os.path.isfile", return_value=True):
                    self.assertEqual(
                        crypt.gen_keys(
                            "/keydir", "keyname", 2048, passphrase="password"
                        ),
                        "/keydir{0}keyname.pem".format(os.sep),
                    )
                    save_pem.assert_not_called()
                    save_pub.assert_not_called()

                with patch("os.path.isfile", return_value=False):
                    self.assertEqual(
                        crypt.gen_keys(
                            "/keydir", "keyname", 2048, passphrase="password"
                        ),
                        "/keydir{0}keyname.pem".format(os.sep),
                    )
                    callback = save_pem.call_args[1]["callback"]
                    save_pem.assert_called_once_with(
                        "/keydir{0}keyname.pem".format(os.sep),
                        cipher="des_ede3_cbc",
                        callback=callback,
                    )
                    self.assertEqual(callback(None), b"password")
                    save_pub.assert_called_once_with(
                        "/keydir{0}keyname.pub".format(os.sep)
                    )

    def test_sign_message(self):
        key = M2Crypto.RSA.load_key_string(six.b(PRIVKEY_DATA))
        with patch("salt.crypt.get_rsa_key", return_value=key):
            self.assertEqual(SIG, salt.crypt.sign_message("/keydir/keyname.pem", MSG))

    def test_sign_message_with_passphrase(self):
        key = M2Crypto.RSA.load_key_string(six.b(PRIVKEY_DATA))
        with patch("salt.crypt.get_rsa_key", return_value=key):
            self.assertEqual(
                SIG,
                crypt.sign_message("/keydir/keyname.pem", MSG, passphrase="password"),
            )

    def test_verify_signature(self):
        with patch("salt.utils.files.fopen", mock_open(read_data=six.b(PUBKEY_DATA))):
            self.assertTrue(crypt.verify_signature("/keydir/keyname.pub", MSG, SIG))

    def test_encrypt_decrypt_bin(self):
        priv_key = M2Crypto.RSA.load_key_string(six.b(PRIVKEY_DATA))
        pub_key = M2Crypto.RSA.load_pub_key_bio(
            M2Crypto.BIO.MemoryBuffer(six.b(PUBKEY_DATA))
        )
        encrypted = salt.crypt.private_encrypt(priv_key, b"salt")
        decrypted = salt.crypt.public_decrypt(pub_key, encrypted)
        self.assertEqual(b"salt", decrypted)


class TestBadCryptodomePubKey(TestCase):
    """
    Test that we can load public keys exported by pycrpytodome<=3.4.6
    """

    TEST_KEY = (
        "-----BEGIN RSA PUBLIC KEY-----\n"
        "MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAzLtFhsvfbFDFaUgulSEX\n"
        "Gl12XriL1DT78Ef2/u8HHaSMmPie37BLWas/zaHwI6066bIyYQJ/nUCahTaoHM7L\n"
        "GlWc0wOU6zyfpihCRQHil05Y6F+olFBoZuYbFPvtp7/hJx/D7I/0n2o/c7M5i3Y2\n"
        "3sBxAYNooIQHXHUmPQW6C9iu95ylZDW8JQzYy/EI4vCC8yQMdTK8jK1FQV0Sbwny\n"
        "qcMxSyAWDoFbnhh2P2TnO8HOWuUOaXR8ZHOJzVcDl+a6ew+medW090x3K5O1f80D\n"
        "+WjgnG6b2HG7VQpOCfM2GALD/FrxicPilvZ38X1aLhJuwjmVE4LAAv8DVNJXohaO\n"
        "WQIDAQAB\n"
        "-----END RSA PUBLIC KEY-----\n"
    )

    def setUp(self):
        self.test_dir = tempfile.mkdtemp()
        self.key_path = os.path.join(self.test_dir, "cryptodom-3.4.6.pub")
        with salt.utils.files.fopen(self.key_path, "wb") as fd:
            fd.write(self.TEST_KEY.encode())

    def tearDown(self):
        shutil.rmtree(self.test_dir)

    @skipIf(not HAS_M2, "Skip when m2crypto is not installed")
    def test_m2_bad_key(self):
        """
        Load public key with an invalid header using m2crypto and validate it
        """
        key = salt.crypt.get_rsa_pub_key(self.key_path)
        assert key.check_key() == 1

    @skipIf(HAS_M2, "Skip when m2crypto is installed")
    def test_crypto_bad_key(self):
        """
        Load public key with an invalid header and validate it without m2crypto
        """
        key = salt.crypt.get_rsa_pub_key(self.key_path)
        assert key.can_encrypt()


class TestM2CryptoRegression47124(TestCase):

    SIGNATURE = (
        b"w\xac\xfe18o\xeb\xfb\x14+\x9e\xd1\xb7\x7fe}\xec\xd6\xe1P\x9e\xab"
        b"\xb5\x07\xe0\xc1\xfd\xda#\x04Z\x8d\x7f\x0b\x1f}:~\xb2s\x860u\x02N"
        b'\xd4q"\xb7\x86*\x8f\x1f\xd0\x9d\x11\x92\xc5~\xa68\xac>\x12H\xc2%y,'
        b"\xe6\xceU\x1e\xa3?\x0c,\xf0u\xbb\xd0[g_\xdd\x8b\xb0\x95:Y\x18\xa5*"
        b"\x99\xfd\xf3K\x92\x92 ({\xd1\xff\xd9F\xc8\xd6K\x86e\xf9\xa8\xad\xb0z"
        b"\xe3\x9dD\xf5k\x8b_<\xe7\xe7\xec\xf3\"'\xd5\xd2M\xb4\xce\x1a\xe3$"
        b"\x9c\x81\xad\xf9\x11\xf6\xf5>)\xc7\xdd\x03&\xf7\x86@ks\xa6\x05\xc2"
        b"\xd0\xbd\x1a7\xfc\xde\xe6\xb0\xad!\x12#\xc86Y\xea\xc5\xe3\xe2\xb3"
        b"\xc9\xaf\xfa\x0c\xf2?\xbf\x93w\x18\x9e\x0b\xa2a\x10:M\x05\x89\xe2W.Q"
        b"\xe8;yGT\xb1\xf2\xc6A\xd2\xc4\xbeN\xb3\xcfS\xaf\x03f\xe2\xb4)\xe7\xf6"
        b'\xdbs\xd0Z}8\xa4\xd2\x1fW*\xe6\x1c"\x8b\xd0\x18w\xb9\x7f\x9e\x96\xa3'
        b"\xd9v\xf7\x833\x8e\x01"
    )

    @skipIf(not HAS_M2, "Skip when m2crypto is not installed")
    def test_m2crypto_verify_bytes(self):
        message = salt.utils.stringutils.to_unicode("meh")
        with patch("salt.utils.files.fopen", mock_open(read_data=six.b(PUBKEY_DATA))):
            salt.crypt.verify_signature("/keydir/keyname.pub", message, self.SIGNATURE)

    @skipIf(not HAS_M2, "Skip when m2crypto is not installed")
    def test_m2crypto_verify_unicode(self):
        message = salt.utils.stringutils.to_bytes("meh")
        with patch("salt.utils.files.fopen", mock_open(read_data=six.b(PUBKEY_DATA))):
            salt.crypt.verify_signature("/keydir/keyname.pub", message, self.SIGNATURE)

    @skipIf(not HAS_M2, "Skip when m2crypto is not installed")
    def test_m2crypto_sign_bytes(self):
        message = salt.utils.stringutils.to_unicode("meh")
        key = M2Crypto.RSA.load_key_string(six.b(PRIVKEY_DATA))
        with patch("salt.crypt.get_rsa_key", return_value=key):
            signature = salt.crypt.sign_message(
                "/keydir/keyname.pem", message, passphrase="password"
            )
        self.assertEqual(signature, self.SIGNATURE)

    @skipIf(not HAS_M2, "Skip when m2crypto is not installed")
    def test_m2crypto_sign_unicode(self):
        message = salt.utils.stringutils.to_bytes("meh")
        key = M2Crypto.RSA.load_key_string(six.b(PRIVKEY_DATA))
        with patch("salt.crypt.get_rsa_key", return_value=key):
            signature = salt.crypt.sign_message(
                "/keydir/keyname.pem", message, passphrase="password"
            )
        self.assertEqual(signature, self.SIGNATURE)