Documentation
¶
Overview ¶
Package aws_role may be used by service code to obtain Keymaster-issued identity certificates. The identity certificate will contain the AWS IAM role that the service code is able to assume (i.e. EC2 instance profile, EKS IRSA, Lambda role). The full AWS Role ARN is stored in a certificate URI SAN extension and a simplified form of the ARN is stored in the certificate CN.
The full AWS Role ARN will reflect the actual role ARN, rather than an ARN showing how the credentials were obtained. This mirrors the way AWS policy documents are written. The ARN will have the form: arn:aws:iam::$AccountId:role/$RoleName
The service code does not require any extra permissions. It uses the sts:GetCallerIdentity permission that is available to all AWS identities. Thus, no policy configuration is required.
This code uses the AWS IAM credentials to request a pre-signed URL from the AWS Security Token Service (STS). This pre-signed URL is passed to Keymaster which can make a request using the URL to verify the identity of the caller. No credentials are sent.
The protocol is a simple HTTPS/REST interface, typically located on the path: /aws/requestRoleCertificate/v1 The client issues a POST request with the following headers:
Claimed-Arn: the full AWS Role ARN Presigned-Method: the method type specified in the pre-signing response Presigned-URL: the URL specified in the pre-signing response
The body of the request must contain a PEM-encoded Public Key DER. On success, the response body will contain a signed, PEM-encoded X.509 Certificate.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GetRoleCertificate ¶
GetRoleCertificate requests an AWS role identify certificate from the Keymaster server specified in params. It returns the certificate PEM.
func GetRoleCertificateTLS ¶
func GetRoleCertificateTLS(params Params) (*tls.Certificate, error)
GetRoleCertificateTLS requests an AWS role identify certificate from the Keymaster server specified in params. It returns the certificate.
Types ¶
type Manager ¶
type Manager struct {
// contains filtered or unexported fields
}
func NewManager ¶
NewManager returns a certificate manager which provides AWS role identity certificates from the Keymaster server specified in params. Certificates are refreshed in the background.
func (*Manager) GetClientCertificate ¶
func (m *Manager) GetClientCertificate(cri *tls.CertificateRequestInfo) ( *tls.Certificate, error)
GetClientCertificate returns a valid, cached certificate. The method value may be assigned to the crypto/tls.Config.GetClientCertificate field.
func (*Manager) GetRoleCertificate ¶ added in v1.10.0
func (m *Manager) GetRoleCertificate() ([]byte, *tls.Certificate, error)
GetRoleCertificate returns a valid, cached certificate. It returns the certificate PEM, TLS certificate and error.
func (*Manager) WaitForRefresh ¶ added in v1.10.0
func (m *Manager) WaitForRefresh()
WaitForRefresh waits until a successful certificate refresh.
type Params ¶
type Params struct {
// Required parameters.
KeymasterServer string
Logger log.DebugLogger
// Optional parameters.
AwsConfig *aws.Config
Context context.Context
HttpClient *http.Client
Signer crypto.Signer
StsClient *sts.Client
StsPresignClient *sts.PresignClient
// contains filtered or unexported fields
}
Source Files