aws_iam_ssh_public_key Resource
Use the aws_iam_ssh_public_key
InSpec audit resource to test the properties of a singular resource of an AWS SSH public key for an IAM user.
For additional information, including details on parameters and properties, see the AWS documentation on AWS IAM AccessKey..
Install
This resource is available in the Chef InSpec AWS resource pack.
For information on configuring your AWS environment for Chef InSpec and creating an InSpec profile that uses the InSpec AWS resource pack, see the Chef InSpec documentation on the AWS cloud platform.
Syntax
Ensure that the public key exists.
describe aws_iam_ssh_public_key(user_name: 'USER_NAME', ssh_public_key_id: 'KEY_ID', encoding: 'SSH') do
it { should exist }
end
Parameters
user_name
(required)The IAM user name associated with the SSH public key.
ssh_public_key_id
(required)The unique identifier for the SSH public key.
encoding
(required)Specifies the public key encoding format to use in the response. To retrieve the public key in SSH-RSA format, use
SSH
. To retrieve the public key in PEM format, usePEM
.
Properties
user_name
- The name of the IAM user associated with the SSH public key.
ssh_public_key_id
- The unique identifier for the SSH public key.
fingerprint
- The MD5 message digest of the SSH public key.
ssh_public_key_body
- The SSH public key.
status
- The status of the SSH public key.
upload_date
- The date and time, in ISO 8601 date-time format, when the SSH public key is uploaded.
ssh_key_age_valid
- This is a customized parameter. It helps to check AWS IAM SSH keys’s age rotated within 730 days. It returns a boolean value.
Examples
Ensure a user name is available.
describe aws_iam_ssh_public_key(user_name: 'USER_NAME', ssh_public_key_id: 'KEY_ID', encoding: 'SSH') do
its('user_name') { should eq 'USER_NAME' }
end
Ensure an SSH public key ID is available.
describe aws_iam_ssh_public_key(user_name: 'USER_NAME', ssh_public_key_id: 'KEY_ID', encoding: 'SSH') do
its('ssh_public_key_id') { should eq 'SSH_PUBLIC_KEY_ID' }
end
Ensure SSH key is expired or not.
describe aws_iam_ssh_public_key(user_name: 'USER_NAME', ssh_public_key_id: 'KEY_ID', encoding: 'SSH') do
its('ssh_key_age_valid') { should eq true }
end
Matchers
For a full list of available matchers, see our Universal Matchers page.The control passes if the get
method returns at least one result.
exist
Use should
to test that the entity exists.
describe aws_iam_ssh_public_key(user_name: 'USER_NAME', ssh_public_key_id: 'KEY_ID', encoding: 'SSH') do
it { should exist }
end
Use should_not
to test the entity does not exist.
describe aws_iam_ssh_public_key(user_name: 'USER_NAME', ssh_public_key_id: 'KEY_ID', encoding: 'SSH') do
it { should_not exist }
end
be_available
Use should
to check if the entity is available.
describe aws_iam_ssh_public_key(user_name: 'USER_NAME', ssh_public_key_id: 'KEY_ID', encoding: 'SSH') do
it { should be_available }
end
AWS Permissions
Your Principal will need the IAM:Client:GetSSHPublicKeyResponse
action with Effect
set to Allow
.