mirror of
https://github.com/ansible/awx.git
synced 2026-05-17 22:37:41 -02:30
properly validate ssh_key_unlock for Net and SCM credentials
see: #6460
This commit is contained in:
@@ -501,7 +501,10 @@ class CredentialInputField(JSONSchemaField):
|
|||||||
|
|
||||||
# `ssh_key_unlock` requirements are very specific and can't be
|
# `ssh_key_unlock` requirements are very specific and can't be
|
||||||
# represented without complicated JSON schema
|
# represented without complicated JSON schema
|
||||||
if model_instance.credential_type.kind == 'ssh':
|
if (
|
||||||
|
model_instance.credential_type.managed_by_tower is True and
|
||||||
|
'ssh_key_unlock' in model_instance.credential_type.defined_fields
|
||||||
|
):
|
||||||
if model_instance.has_encrypted_ssh_key_data and not value.get('ssh_key_unlock'):
|
if model_instance.has_encrypted_ssh_key_data and not value.get('ssh_key_unlock'):
|
||||||
errors['ssh_key_unlock'] = [_('must be set when SSH key is encrypted.')]
|
errors['ssh_key_unlock'] = [_('must be set when SSH key is encrypted.')]
|
||||||
if not model_instance.has_encrypted_ssh_key_data and value.get('ssh_key_unlock'):
|
if not model_instance.has_encrypted_ssh_key_data and value.get('ssh_key_unlock'):
|
||||||
|
|||||||
@@ -6,6 +6,7 @@ from awx.main.utils.common import decrypt_field
|
|||||||
from awx.api.versioning import reverse
|
from awx.api.versioning import reverse
|
||||||
|
|
||||||
EXAMPLE_PRIVATE_KEY = '-----BEGIN PRIVATE KEY-----\nxyz==\n-----END PRIVATE KEY-----'
|
EXAMPLE_PRIVATE_KEY = '-----BEGIN PRIVATE KEY-----\nxyz==\n-----END PRIVATE KEY-----'
|
||||||
|
EXAMPLE_ENCRYPTED_PRIVATE_KEY = '-----BEGIN PRIVATE KEY-----\nProc-Type: 4,ENCRYPTED\nxyz==\n-----END PRIVATE KEY-----'
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.django_db
|
@pytest.mark.django_db
|
||||||
@@ -666,7 +667,7 @@ def test_inputs_cannot_contain_extra_fields(get, post, organization, admin, cred
|
|||||||
'name': 'Best credential ever',
|
'name': 'Best credential ever',
|
||||||
'username': 'some_username',
|
'username': 'some_username',
|
||||||
'password': 'some_password',
|
'password': 'some_password',
|
||||||
'ssh_key_data': EXAMPLE_PRIVATE_KEY,
|
'ssh_key_data': EXAMPLE_ENCRYPTED_PRIVATE_KEY,
|
||||||
'ssh_key_unlock': 'some_key_unlock',
|
'ssh_key_unlock': 'some_key_unlock',
|
||||||
}],
|
}],
|
||||||
['v2', {
|
['v2', {
|
||||||
@@ -675,7 +676,7 @@ def test_inputs_cannot_contain_extra_fields(get, post, organization, admin, cred
|
|||||||
'inputs': {
|
'inputs': {
|
||||||
'username': 'some_username',
|
'username': 'some_username',
|
||||||
'password': 'some_password',
|
'password': 'some_password',
|
||||||
'ssh_key_data': EXAMPLE_PRIVATE_KEY,
|
'ssh_key_data': EXAMPLE_ENCRYPTED_PRIVATE_KEY,
|
||||||
'ssh_key_unlock': 'some_key_unlock',
|
'ssh_key_unlock': 'some_key_unlock',
|
||||||
}
|
}
|
||||||
}]
|
}]
|
||||||
@@ -695,7 +696,7 @@ def test_scm_create_ok(post, organization, admin, version, params):
|
|||||||
cred = Credential.objects.all()[:1].get()
|
cred = Credential.objects.all()[:1].get()
|
||||||
assert cred.inputs['username'] == 'some_username'
|
assert cred.inputs['username'] == 'some_username'
|
||||||
assert decrypt_field(cred, 'password') == 'some_password'
|
assert decrypt_field(cred, 'password') == 'some_password'
|
||||||
assert decrypt_field(cred, 'ssh_key_data') == EXAMPLE_PRIVATE_KEY
|
assert decrypt_field(cred, 'ssh_key_data') == EXAMPLE_ENCRYPTED_PRIVATE_KEY
|
||||||
assert decrypt_field(cred, 'ssh_key_unlock') == 'some_key_unlock'
|
assert decrypt_field(cred, 'ssh_key_unlock') == 'some_key_unlock'
|
||||||
|
|
||||||
|
|
||||||
@@ -798,7 +799,7 @@ def test_vault_create_ok(post, organization, admin, version, params):
|
|||||||
'name': 'Best credential ever',
|
'name': 'Best credential ever',
|
||||||
'username': 'some_username',
|
'username': 'some_username',
|
||||||
'password': 'some_password',
|
'password': 'some_password',
|
||||||
'ssh_key_data': EXAMPLE_PRIVATE_KEY,
|
'ssh_key_data': EXAMPLE_ENCRYPTED_PRIVATE_KEY,
|
||||||
'ssh_key_unlock': 'some_key_unlock',
|
'ssh_key_unlock': 'some_key_unlock',
|
||||||
'authorize': True,
|
'authorize': True,
|
||||||
'authorize_password': 'some_authorize_password',
|
'authorize_password': 'some_authorize_password',
|
||||||
@@ -809,7 +810,7 @@ def test_vault_create_ok(post, organization, admin, version, params):
|
|||||||
'inputs': {
|
'inputs': {
|
||||||
'username': 'some_username',
|
'username': 'some_username',
|
||||||
'password': 'some_password',
|
'password': 'some_password',
|
||||||
'ssh_key_data': EXAMPLE_PRIVATE_KEY,
|
'ssh_key_data': EXAMPLE_ENCRYPTED_PRIVATE_KEY,
|
||||||
'ssh_key_unlock': 'some_key_unlock',
|
'ssh_key_unlock': 'some_key_unlock',
|
||||||
'authorize': True,
|
'authorize': True,
|
||||||
'authorize_password': 'some_authorize_password',
|
'authorize_password': 'some_authorize_password',
|
||||||
@@ -831,7 +832,7 @@ def test_net_create_ok(post, organization, admin, version, params):
|
|||||||
cred = Credential.objects.all()[:1].get()
|
cred = Credential.objects.all()[:1].get()
|
||||||
assert cred.inputs['username'] == 'some_username'
|
assert cred.inputs['username'] == 'some_username'
|
||||||
assert decrypt_field(cred, 'password') == 'some_password'
|
assert decrypt_field(cred, 'password') == 'some_password'
|
||||||
assert decrypt_field(cred, 'ssh_key_data') == EXAMPLE_PRIVATE_KEY
|
assert decrypt_field(cred, 'ssh_key_data') == EXAMPLE_ENCRYPTED_PRIVATE_KEY
|
||||||
assert decrypt_field(cred, 'ssh_key_unlock') == 'some_key_unlock'
|
assert decrypt_field(cred, 'ssh_key_unlock') == 'some_key_unlock'
|
||||||
assert decrypt_field(cred, 'authorize_password') == 'some_authorize_password'
|
assert decrypt_field(cred, 'authorize_password') == 'some_authorize_password'
|
||||||
assert cred.inputs['authorize'] is True
|
assert cred.inputs['authorize'] is True
|
||||||
|
|||||||
@@ -211,6 +211,7 @@ def test_credential_creation_validation_failure(organization_factory, inputs):
|
|||||||
|
|
||||||
|
|
||||||
@pytest.mark.django_db
|
@pytest.mark.django_db
|
||||||
|
@pytest.mark.parametrize('kind', ['ssh', 'net', 'scm'])
|
||||||
@pytest.mark.parametrize('ssh_key_data, ssh_key_unlock, valid', [
|
@pytest.mark.parametrize('ssh_key_data, ssh_key_unlock, valid', [
|
||||||
[EXAMPLE_PRIVATE_KEY, None, True], # unencrypted key, no unlock pass
|
[EXAMPLE_PRIVATE_KEY, None, True], # unencrypted key, no unlock pass
|
||||||
[EXAMPLE_PRIVATE_KEY, 'super-secret', False], # unencrypted key, unlock pass
|
[EXAMPLE_PRIVATE_KEY, 'super-secret', False], # unencrypted key, unlock pass
|
||||||
@@ -221,14 +222,16 @@ def test_credential_creation_validation_failure(organization_factory, inputs):
|
|||||||
['INVALID-KEY-DATA', None, False], # invalid key data
|
['INVALID-KEY-DATA', None, False], # invalid key data
|
||||||
[EXAMPLE_PRIVATE_KEY.replace('=', '\u003d'), None, True], # automatically fix JSON-encoded GCE keys
|
[EXAMPLE_PRIVATE_KEY.replace('=', '\u003d'), None, True], # automatically fix JSON-encoded GCE keys
|
||||||
])
|
])
|
||||||
def test_ssh_key_data_validation(credentialtype_ssh, organization, ssh_key_data, ssh_key_unlock, valid):
|
def test_ssh_key_data_validation(organization, kind, ssh_key_data, ssh_key_unlock, valid):
|
||||||
inputs = {}
|
inputs = {}
|
||||||
if ssh_key_data:
|
if ssh_key_data:
|
||||||
inputs['ssh_key_data'] = ssh_key_data
|
inputs['ssh_key_data'] = ssh_key_data
|
||||||
if ssh_key_unlock:
|
if ssh_key_unlock:
|
||||||
inputs['ssh_key_unlock'] = ssh_key_unlock
|
inputs['ssh_key_unlock'] = ssh_key_unlock
|
||||||
|
cred_type = CredentialType.defaults[kind]()
|
||||||
|
cred_type.save()
|
||||||
cred = Credential(
|
cred = Credential(
|
||||||
credential_type=credentialtype_ssh,
|
credential_type=cred_type,
|
||||||
name="Best credential ever",
|
name="Best credential ever",
|
||||||
inputs=inputs,
|
inputs=inputs,
|
||||||
organization=organization
|
organization=organization
|
||||||
|
|||||||
Reference in New Issue
Block a user