1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640
|
# Copyright 2020 Google LLC
#
# 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 os
import re
import mock
from OpenSSL import crypto
import pytest # type: ignore
from google.auth import exceptions
from google.auth.transport import _mtls_helper
CONTEXT_AWARE_METADATA = {"cert_provider_command": ["some command"]}
ENCRYPTED_EC_PRIVATE_KEY = b"""-----BEGIN ENCRYPTED PRIVATE KEY-----
MIHkME8GCSqGSIb3DQEFDTBCMCkGCSqGSIb3DQEFDDAcBAgl2/yVgs1h3QICCAAw
DAYIKoZIhvcNAgkFADAVBgkrBgEEAZdVAQIECJk2GRrvxOaJBIGQXIBnMU4wmciT
uA6yD8q0FxuIzjG7E2S6tc5VRgSbhRB00eBO3jWmO2pBybeQW+zVioDcn50zp2ts
wYErWC+LCm1Zg3r+EGnT1E1GgNoODbVQ3AEHlKh1CGCYhEovxtn3G+Fjh7xOBrNB
saVVeDb4tHD4tMkiVVUBrUcTZPndP73CtgyGHYEphasYPzEz3+AU
-----END ENCRYPTED PRIVATE KEY-----"""
EC_PUBLIC_KEY = b"""-----BEGIN PUBLIC KEY-----
MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEvCNi1NoDY1oMqPHIgXI8RBbTYGi/
brEjbre1nSiQW11xRTJbVeETdsuP0EAu2tG3PcRhhwDfeJ8zXREgTBurNw==
-----END PUBLIC KEY-----"""
PASSPHRASE = b"""-----BEGIN PASSPHRASE-----
password
-----END PASSPHRASE-----"""
PASSPHRASE_VALUE = b"password"
def check_cert_and_key(content, expected_cert, expected_key):
success = True
cert_match = re.findall(_mtls_helper._CERT_REGEX, content)
success = success and len(cert_match) == 1 and cert_match[0] == expected_cert
key_match = re.findall(_mtls_helper._KEY_REGEX, content)
success = success and len(key_match) == 1 and key_match[0] == expected_key
return success
class TestCertAndKeyRegex(object):
def test_cert_and_key(self):
# Test single cert and single key
check_cert_and_key(
pytest.public_cert_bytes + pytest.private_key_bytes,
pytest.public_cert_bytes,
pytest.private_key_bytes,
)
check_cert_and_key(
pytest.private_key_bytes + pytest.public_cert_bytes,
pytest.public_cert_bytes,
pytest.private_key_bytes,
)
# Test cert chain and single key
check_cert_and_key(
pytest.public_cert_bytes
+ pytest.public_cert_bytes
+ pytest.private_key_bytes,
pytest.public_cert_bytes + pytest.public_cert_bytes,
pytest.private_key_bytes,
)
check_cert_and_key(
pytest.private_key_bytes
+ pytest.public_cert_bytes
+ pytest.public_cert_bytes,
pytest.public_cert_bytes + pytest.public_cert_bytes,
pytest.private_key_bytes,
)
def test_key(self):
# Create some fake keys for regex check.
KEY = b"""-----BEGIN PRIVATE KEY-----
MIIBCgKCAQEA4ej0p7bQ7L/r4rVGUz9RN4VQWoej1Bg1mYWIDYslvKrk1gpj7wZg
/fy3ZpsL7WqgsZS7Q+0VRK8gKfqkxg5OYQIDAQAB
-----END PRIVATE KEY-----"""
RSA_KEY = b"""-----BEGIN RSA PRIVATE KEY-----
MIIBCgKCAQEA4ej0p7bQ7L/r4rVGUz9RN4VQWoej1Bg1mYWIDYslvKrk1gpj7wZg
/fy3ZpsL7WqgsZS7Q+0VRK8gKfqkxg5OYQIDAQAB
-----END RSA PRIVATE KEY-----"""
EC_KEY = b"""-----BEGIN EC PRIVATE KEY-----
MIIBCgKCAQEA4ej0p7bQ7L/r4rVGUz9RN4VQWoej1Bg1mYWIDYslvKrk1gpj7wZg
/fy3ZpsL7WqgsZS7Q+0VRK8gKfqkxg5OYQIDAQAB
-----END EC PRIVATE KEY-----"""
check_cert_and_key(
pytest.public_cert_bytes + KEY, pytest.public_cert_bytes, KEY
)
check_cert_and_key(
pytest.public_cert_bytes + RSA_KEY, pytest.public_cert_bytes, RSA_KEY
)
check_cert_and_key(
pytest.public_cert_bytes + EC_KEY, pytest.public_cert_bytes, EC_KEY
)
class TestCheckConfigPath(object):
def test_success(self):
metadata_path = os.path.join(pytest.data_dir, "context_aware_metadata.json")
returned_path = _mtls_helper._check_config_path(metadata_path)
assert returned_path is not None
def test_failure(self):
metadata_path = os.path.join(pytest.data_dir, "not_exists.json")
returned_path = _mtls_helper._check_config_path(metadata_path)
assert returned_path is None
class TestReadMetadataFile(object):
def test_success(self):
metadata_path = os.path.join(pytest.data_dir, "context_aware_metadata.json")
metadata = _mtls_helper._load_json_file(metadata_path)
assert "cert_provider_command" in metadata
def test_file_not_json(self):
# read a file which is not json format.
metadata_path = os.path.join(pytest.data_dir, "privatekey.pem")
with pytest.raises(exceptions.ClientCertError):
_mtls_helper._load_json_file(metadata_path)
class TestRunCertProviderCommand(object):
def create_mock_process(self, output, error):
# There are two steps to execute a script with subprocess.Popen.
# (1) process = subprocess.Popen([comannds])
# (2) stdout, stderr = process.communicate()
# This function creates a mock process which can be returned by a mock
# subprocess.Popen. The mock process returns the given output and error
# when mock_process.communicate() is called.
mock_process = mock.Mock()
attrs = {"communicate.return_value": (output, error), "returncode": 0}
mock_process.configure_mock(**attrs)
return mock_process
@mock.patch("subprocess.Popen", autospec=True)
def test_success(self, mock_popen):
mock_popen.return_value = self.create_mock_process(
pytest.public_cert_bytes + pytest.private_key_bytes, b""
)
cert, key, passphrase = _mtls_helper._run_cert_provider_command(["command"])
assert cert == pytest.public_cert_bytes
assert key == pytest.private_key_bytes
assert passphrase is None
mock_popen.return_value = self.create_mock_process(
pytest.public_cert_bytes + ENCRYPTED_EC_PRIVATE_KEY + PASSPHRASE, b""
)
cert, key, passphrase = _mtls_helper._run_cert_provider_command(
["command"], expect_encrypted_key=True
)
assert cert == pytest.public_cert_bytes
assert key == ENCRYPTED_EC_PRIVATE_KEY
assert passphrase == PASSPHRASE_VALUE
@mock.patch("subprocess.Popen", autospec=True)
def test_success_with_cert_chain(self, mock_popen):
PUBLIC_CERT_CHAIN_BYTES = pytest.public_cert_bytes + pytest.public_cert_bytes
mock_popen.return_value = self.create_mock_process(
PUBLIC_CERT_CHAIN_BYTES + pytest.private_key_bytes, b""
)
cert, key, passphrase = _mtls_helper._run_cert_provider_command(["command"])
assert cert == PUBLIC_CERT_CHAIN_BYTES
assert key == pytest.private_key_bytes
assert passphrase is None
mock_popen.return_value = self.create_mock_process(
PUBLIC_CERT_CHAIN_BYTES + ENCRYPTED_EC_PRIVATE_KEY + PASSPHRASE, b""
)
cert, key, passphrase = _mtls_helper._run_cert_provider_command(
["command"], expect_encrypted_key=True
)
assert cert == PUBLIC_CERT_CHAIN_BYTES
assert key == ENCRYPTED_EC_PRIVATE_KEY
assert passphrase == PASSPHRASE_VALUE
@mock.patch("subprocess.Popen", autospec=True)
def test_missing_cert(self, mock_popen):
mock_popen.return_value = self.create_mock_process(
pytest.private_key_bytes, b""
)
with pytest.raises(exceptions.ClientCertError):
_mtls_helper._run_cert_provider_command(["command"])
mock_popen.return_value = self.create_mock_process(
ENCRYPTED_EC_PRIVATE_KEY + PASSPHRASE, b""
)
with pytest.raises(exceptions.ClientCertError):
_mtls_helper._run_cert_provider_command(
["command"], expect_encrypted_key=True
)
@mock.patch("subprocess.Popen", autospec=True)
def test_missing_key(self, mock_popen):
mock_popen.return_value = self.create_mock_process(
pytest.public_cert_bytes, b""
)
with pytest.raises(exceptions.ClientCertError):
_mtls_helper._run_cert_provider_command(["command"])
mock_popen.return_value = self.create_mock_process(
pytest.public_cert_bytes + PASSPHRASE, b""
)
with pytest.raises(exceptions.ClientCertError):
_mtls_helper._run_cert_provider_command(
["command"], expect_encrypted_key=True
)
@mock.patch("subprocess.Popen", autospec=True)
def test_missing_passphrase(self, mock_popen):
mock_popen.return_value = self.create_mock_process(
pytest.public_cert_bytes + ENCRYPTED_EC_PRIVATE_KEY, b""
)
with pytest.raises(exceptions.ClientCertError):
_mtls_helper._run_cert_provider_command(
["command"], expect_encrypted_key=True
)
@mock.patch("subprocess.Popen", autospec=True)
def test_passphrase_not_expected(self, mock_popen):
mock_popen.return_value = self.create_mock_process(
pytest.public_cert_bytes + pytest.private_key_bytes + PASSPHRASE, b""
)
with pytest.raises(exceptions.ClientCertError):
_mtls_helper._run_cert_provider_command(["command"])
@mock.patch("subprocess.Popen", autospec=True)
def test_encrypted_key_expected(self, mock_popen):
mock_popen.return_value = self.create_mock_process(
pytest.public_cert_bytes + pytest.private_key_bytes + PASSPHRASE, b""
)
with pytest.raises(exceptions.ClientCertError):
_mtls_helper._run_cert_provider_command(
["command"], expect_encrypted_key=True
)
@mock.patch("subprocess.Popen", autospec=True)
def test_unencrypted_key_expected(self, mock_popen):
mock_popen.return_value = self.create_mock_process(
pytest.public_cert_bytes + ENCRYPTED_EC_PRIVATE_KEY, b""
)
with pytest.raises(exceptions.ClientCertError):
_mtls_helper._run_cert_provider_command(["command"])
@mock.patch("subprocess.Popen", autospec=True)
def test_cert_provider_returns_error(self, mock_popen):
mock_popen.return_value = self.create_mock_process(b"", b"some error")
mock_popen.return_value.returncode = 1
with pytest.raises(exceptions.ClientCertError):
_mtls_helper._run_cert_provider_command(["command"])
@mock.patch("subprocess.Popen", autospec=True)
def test_popen_raise_exception(self, mock_popen):
mock_popen.side_effect = OSError()
with pytest.raises(exceptions.ClientCertError):
_mtls_helper._run_cert_provider_command(["command"])
class TestGetClientSslCredentials(object):
@mock.patch(
"google.auth.transport._mtls_helper._get_workload_cert_and_key", autospec=True
)
@mock.patch(
"google.auth.transport._mtls_helper._run_cert_provider_command", autospec=True
)
@mock.patch("google.auth.transport._mtls_helper._load_json_file", autospec=True)
@mock.patch("google.auth.transport._mtls_helper._check_config_path", autospec=True)
def test_success_with_context_aware_metadata(
self,
mock_check_config_path,
mock_load_json_file,
mock_run_cert_provider_command,
mock_get_workload_cert_and_key,
):
mock_check_config_path.return_value = "/path/to/config"
mock_load_json_file.return_value = {"cert_provider_command": ["command"]}
mock_run_cert_provider_command.return_value = (b"cert", b"key", None)
mock_get_workload_cert_and_key.return_value = (None, None)
has_cert, cert, key, passphrase = _mtls_helper.get_client_ssl_credentials()
assert has_cert
assert cert == b"cert"
assert key == b"key"
assert passphrase is None
@mock.patch(
"google.auth.transport._mtls_helper._read_cert_and_key_files", autospec=True
)
@mock.patch(
"google.auth.transport._mtls_helper._get_cert_config_path", autospec=True
)
@mock.patch("google.auth.transport._mtls_helper._load_json_file", autospec=True)
@mock.patch("google.auth.transport._mtls_helper._check_config_path", autospec=True)
def test_success_with_certificate_config(
self,
mock_check_config_path,
mock_load_json_file,
mock_get_cert_config_path,
mock_read_cert_and_key_files,
):
cert_config_path = "/path/to/config"
mock_check_config_path.return_value = cert_config_path
mock_load_json_file.return_value = {
"cert_configs": {
"workload": {"cert_path": "cert/path", "key_path": "key/path"}
}
}
mock_get_cert_config_path.return_value = cert_config_path
mock_read_cert_and_key_files.return_value = (
pytest.public_cert_bytes,
pytest.private_key_bytes,
)
has_cert, cert, key, passphrase = _mtls_helper.get_client_ssl_credentials()
assert has_cert
assert cert == pytest.public_cert_bytes
assert key == pytest.private_key_bytes
assert passphrase is None
@mock.patch("google.auth.transport._mtls_helper._check_config_path", autospec=True)
def test_success_without_metadata(self, mock_check_config_path):
mock_check_config_path.return_value = False
has_cert, cert, key, passphrase = _mtls_helper.get_client_ssl_credentials()
assert not has_cert
assert cert is None
assert key is None
assert passphrase is None
@mock.patch(
"google.auth.transport._mtls_helper._get_workload_cert_and_key", autospec=True
)
@mock.patch(
"google.auth.transport._mtls_helper._run_cert_provider_command", autospec=True
)
@mock.patch("google.auth.transport._mtls_helper._load_json_file", autospec=True)
@mock.patch("google.auth.transport._mtls_helper._check_config_path", autospec=True)
def test_success_with_encrypted_key(
self,
mock_check_config_path,
mock_load_json_file,
mock_run_cert_provider_command,
mock_get_workload_cert_and_key,
):
mock_check_config_path.return_value = "/path/to/config"
mock_load_json_file.return_value = {"cert_provider_command": ["command"]}
mock_run_cert_provider_command.return_value = (b"cert", b"key", b"passphrase")
mock_get_workload_cert_and_key.return_value = (None, None)
has_cert, cert, key, passphrase = _mtls_helper.get_client_ssl_credentials(
generate_encrypted_key=True
)
assert has_cert
assert cert == b"cert"
assert key == b"key"
assert passphrase == b"passphrase"
mock_run_cert_provider_command.assert_called_once_with(
["command", "--with_passphrase"], expect_encrypted_key=True
)
@mock.patch(
"google.auth.transport._mtls_helper._get_workload_cert_and_key", autospec=True
)
@mock.patch("google.auth.transport._mtls_helper._load_json_file", autospec=True)
@mock.patch("google.auth.transport._mtls_helper._check_config_path", autospec=True)
def test_missing_cert_command(
self,
mock_check_config_path,
mock_load_json_file,
mock_get_workload_cert_and_key,
):
mock_check_config_path.return_value = "/path/to/config"
mock_load_json_file.return_value = {}
mock_get_workload_cert_and_key.return_value = (None, None)
with pytest.raises(exceptions.ClientCertError):
_mtls_helper.get_client_ssl_credentials()
@mock.patch(
"google.auth.transport._mtls_helper._run_cert_provider_command", autospec=True
)
@mock.patch("google.auth.transport._mtls_helper._load_json_file", autospec=True)
@mock.patch("google.auth.transport._mtls_helper._check_config_path", autospec=True)
def test_customize_context_aware_metadata_path(
self,
mock_check_config_path,
mock_load_json_file,
mock_run_cert_provider_command,
):
context_aware_metadata_path = "/path/to/metata/data"
mock_check_config_path.return_value = context_aware_metadata_path
mock_load_json_file.return_value = {"cert_provider_command": ["command"]}
mock_run_cert_provider_command.return_value = (b"cert", b"key", None)
has_cert, cert, key, passphrase = _mtls_helper.get_client_ssl_credentials(
context_aware_metadata_path=context_aware_metadata_path
)
assert has_cert
assert cert == b"cert"
assert key == b"key"
assert passphrase is None
mock_check_config_path.assert_called_with(context_aware_metadata_path)
mock_load_json_file.assert_called_with(context_aware_metadata_path)
class TestGetWorkloadCertAndKey(object):
@mock.patch("google.auth.transport._mtls_helper._load_json_file", autospec=True)
@mock.patch(
"google.auth.transport._mtls_helper._get_cert_config_path", autospec=True
)
@mock.patch(
"google.auth.transport._mtls_helper._read_cert_and_key_files", autospec=True
)
def test_success(
self,
mock_read_cert_and_key_files,
mock_get_cert_config_path,
mock_load_json_file,
):
cert_config_path = "/path/to/cert"
mock_get_cert_config_path.return_value = "/path/to/cert"
mock_load_json_file.return_value = {
"cert_configs": {
"workload": {"cert_path": "cert/path", "key_path": "key/path"}
}
}
mock_read_cert_and_key_files.return_value = (
pytest.public_cert_bytes,
pytest.private_key_bytes,
)
actual_cert, actual_key = _mtls_helper._get_workload_cert_and_key(
cert_config_path
)
assert actual_cert == pytest.public_cert_bytes
assert actual_key == pytest.private_key_bytes
@mock.patch(
"google.auth.transport._mtls_helper._get_cert_config_path", autospec=True
)
def test_file_not_found_returns_none(self, mock_get_cert_config_path):
mock_get_cert_config_path.return_value = None
actual_cert, actual_key = _mtls_helper._get_workload_cert_and_key()
assert actual_cert is None
assert actual_key is None
@mock.patch("google.auth.transport._mtls_helper._load_json_file", autospec=True)
@mock.patch(
"google.auth.transport._mtls_helper._get_cert_config_path", autospec=True
)
def test_no_cert_configs(self, mock_get_cert_config_path, mock_load_json_file):
mock_get_cert_config_path.return_value = "/path/to/cert"
mock_load_json_file.return_value = {}
with pytest.raises(exceptions.ClientCertError):
_mtls_helper._get_workload_cert_and_key("")
@mock.patch("google.auth.transport._mtls_helper._load_json_file", autospec=True)
@mock.patch(
"google.auth.transport._mtls_helper._get_cert_config_path", autospec=True
)
def test_no_workload(self, mock_get_cert_config_path, mock_load_json_file):
mock_get_cert_config_path.return_value = "/path/to/cert"
mock_load_json_file.return_value = {"cert_configs": {}}
with pytest.raises(exceptions.ClientCertError):
_mtls_helper._get_workload_cert_and_key("")
@mock.patch("google.auth.transport._mtls_helper._load_json_file", autospec=True)
@mock.patch(
"google.auth.transport._mtls_helper._get_cert_config_path", autospec=True
)
def test_no_cert_file(self, mock_get_cert_config_path, mock_load_json_file):
mock_get_cert_config_path.return_value = "/path/to/cert"
mock_load_json_file.return_value = {
"cert_configs": {"workload": {"key_path": "path/to/key"}}
}
with pytest.raises(exceptions.ClientCertError):
_mtls_helper._get_workload_cert_and_key("")
@mock.patch("google.auth.transport._mtls_helper._load_json_file", autospec=True)
@mock.patch(
"google.auth.transport._mtls_helper._get_cert_config_path", autospec=True
)
def test_no_key_file(self, mock_get_cert_config_path, mock_load_json_file):
mock_get_cert_config_path.return_value = "/path/to/cert"
mock_load_json_file.return_value = {
"cert_configs": {"workload": {"cert_path": "path/to/key"}}
}
with pytest.raises(exceptions.ClientCertError):
_mtls_helper._get_workload_cert_and_key("")
class TestReadCertAndKeyFile(object):
def test_success(self):
cert_path = os.path.join(pytest.data_dir, "public_cert.pem")
key_path = os.path.join(pytest.data_dir, "privatekey.pem")
actual_cert, actual_key = _mtls_helper._read_cert_and_key_files(
cert_path, key_path
)
assert actual_cert == pytest.public_cert_bytes
assert actual_key == pytest.private_key_bytes
def test_no_cert_file(self):
cert_path = "fake/file/path"
key_path = os.path.join(pytest.data_dir, "privatekey.pem")
with pytest.raises(FileNotFoundError):
_mtls_helper._read_cert_and_key_files(cert_path, key_path)
def test_no_key_file(self):
cert_path = os.path.join(pytest.data_dir, "public_cert.pem")
key_path = "fake/file/path"
with pytest.raises(FileNotFoundError):
_mtls_helper._read_cert_and_key_files(cert_path, key_path)
def test_invalid_cert_file(self):
cert_path = os.path.join(pytest.data_dir, "service_account.json")
key_path = os.path.join(pytest.data_dir, "privatekey.pem")
with pytest.raises(exceptions.ClientCertError):
_mtls_helper._read_cert_and_key_files(cert_path, key_path)
def test_invalid_key_file(self):
cert_path = os.path.join(pytest.data_dir, "public_cert.pem")
key_path = os.path.join(pytest.data_dir, "public_cert.pem")
with pytest.raises(exceptions.ClientCertError):
_mtls_helper._read_cert_and_key_files(cert_path, key_path)
class TestGetCertConfigPath(object):
def test_success_with_override(self):
config_path = os.path.join(pytest.data_dir, "service_account.json")
returned_path = _mtls_helper._get_cert_config_path(config_path)
assert returned_path == config_path
def test_override_does_not_exist(self):
config_path = "fake/file/path"
returned_path = _mtls_helper._get_cert_config_path(config_path)
assert returned_path is None
@mock.patch.dict(os.environ, {"GOOGLE_API_CERTIFICATE_CONFIG": ""})
@mock.patch("os.path.exists", autospec=True)
def test_default(self, mock_path_exists):
mock_path_exists.return_value = True
returned_path = _mtls_helper._get_cert_config_path()
expected_path = os.path.expanduser(
_mtls_helper.CERTIFICATE_CONFIGURATION_DEFAULT_PATH
)
assert returned_path == expected_path
@mock.patch.dict(
os.environ, {"GOOGLE_API_CERTIFICATE_CONFIG": "path/to/config/file"}
)
@mock.patch("os.path.exists", autospec=True)
def test_env_variable(self, mock_path_exists):
mock_path_exists.return_value = True
returned_path = _mtls_helper._get_cert_config_path()
expected_path = "path/to/config/file"
assert returned_path == expected_path
@mock.patch.dict(os.environ, {"GOOGLE_API_CERTIFICATE_CONFIG": ""})
@mock.patch("os.path.exists", autospec=True)
def test_env_variable_file_does_not_exist(self, mock_path_exists):
mock_path_exists.return_value = False
returned_path = _mtls_helper._get_cert_config_path()
assert returned_path is None
@mock.patch.dict(
os.environ, {"GOOGLE_API_CERTIFICATE_CONFIG": "path/to/config/file"}
)
@mock.patch("os.path.exists", autospec=True)
def test_default_file_does_not_exist(self, mock_path_exists):
mock_path_exists.return_value = False
returned_path = _mtls_helper._get_cert_config_path()
assert returned_path is None
class TestGetClientCertAndKey(object):
def test_callback_success(self):
callback = mock.Mock()
callback.return_value = (pytest.public_cert_bytes, pytest.private_key_bytes)
found_cert_key, cert, key = _mtls_helper.get_client_cert_and_key(callback)
assert found_cert_key
assert cert == pytest.public_cert_bytes
assert key == pytest.private_key_bytes
@mock.patch(
"google.auth.transport._mtls_helper.get_client_ssl_credentials", autospec=True
)
def test_use_metadata(self, mock_get_client_ssl_credentials):
mock_get_client_ssl_credentials.return_value = (
True,
pytest.public_cert_bytes,
pytest.private_key_bytes,
None,
)
found_cert_key, cert, key = _mtls_helper.get_client_cert_and_key()
assert found_cert_key
assert cert == pytest.public_cert_bytes
assert key == pytest.private_key_bytes
class TestDecryptPrivateKey(object):
def test_success(self):
decrypted_key = _mtls_helper.decrypt_private_key(
ENCRYPTED_EC_PRIVATE_KEY, PASSPHRASE_VALUE
)
private_key = crypto.load_privatekey(crypto.FILETYPE_PEM, decrypted_key)
public_key = crypto.load_publickey(crypto.FILETYPE_PEM, EC_PUBLIC_KEY)
x509 = crypto.X509()
x509.set_pubkey(public_key)
# Test the decrypted key works by signing and verification.
signature = crypto.sign(private_key, b"data", "sha256")
crypto.verify(x509, signature, b"data", "sha256")
def test_crypto_error(self):
with pytest.raises(crypto.Error):
_mtls_helper.decrypt_private_key(
ENCRYPTED_EC_PRIVATE_KEY, b"wrong_password"
)
|