sia

README

SIA for AWS Fargate

Configuration

SIA AWS Fargate requires a configuration file to be present in the /etc/sia/sia_config with the following required attributes:

{
    "version": "1.0.0",
    "service": "application-service-name",
    "accounts": [
        {
            "domain":  "application-domain-name",
            "account": "application-account-aws-id"
        }
    ]
}

The AWS Account administrator must create an IAM Role called <application-domain-name>.<application-service-name> and this role must be setup with a trusted relationship with the role that the Fargate task is configured to run as. ( most likely Task Role )

SIA Configuration file provides a way to change the default user/group settings that the private key is owned by. By default, the private key is owned by user root and readable by group athenz. If the user wants to provide access to their service identity private key to another user, it can be accomplished by adding the user to the group athenz. If the user wants to change the user and group values, a config file must be dropped with the following optional fields:

{
    "version": "1.0.0",
    "service": "application-service-name",
    "accounts": [
        {
            "domain":  "application-domain-name",
            "account": "application-account-aws-id",
            "user": "unix-username",
            "group": "unix-groupname"
        }
    ]
}

SIA-Fargate can be built with following parameters - e.g.

GOOS=linux go install -ldflags "-X main.Version=1.0.0 -X main.ZtsEndPoint=zts.athenz.io -X main.DnsDomain=aws.athenz.cloud -X main.ProviderPrefix=athenz.aws" ./...

alternatively, those parameters can be passed during runtime and runtime parameters will take precedence over build time parameters.

Documentation

Index

• func GetFargateConfig(configFile, metaEndpoint string, useRegionalSTS bool, account, region string) (*options.Config, *options.ConfigAccount, error)
• func GetFargateData(metaEndPoint string) (string, string, string, error)
• type FargateProvider
  • func (fargate FargateProvider) AttestationData(_ string, _ crypto.PrivateKey, _ *signature.SignatureInfo) (string, error)
  • func (fargate FargateProvider) CloudAttestationData(_, _, _ string) (string, error)
  • func (fargate FargateProvider) GetAccessManagementProfileFromMeta(_ string) (string, error)
  • func (fargate FargateProvider) GetAccountDomainServiceFromMeta(_ string) (string, string, string, error)
  • func (fargate FargateProvider) GetAdditionalSshHostPrincipals(_ string) (string, error)
  • func (fargate FargateProvider) GetCsrDn() pkix.Name
  • func (fargate FargateProvider) GetEmail(_ string) []string
  • func (fargate FargateProvider) GetHostname(_ bool) string
  • func (fargate FargateProvider) GetName() string
  • func (fargate FargateProvider) GetRoleDnsNames(_ *x509.Certificate, _ string) []string
  • func (fargate FargateProvider) GetSanDns(_ string, _ bool, _ bool, _ []string) []string
  • func (fargate FargateProvider) GetSanIp(_ map[string]bool, _ []net.IP, _ ip.Opts) []net.IP
  • func (fargate FargateProvider) GetSanUri(_ string, _ ip.Opts, _, _ string) []*url.URL
  • func (fargate FargateProvider) GetSuffixes() []string
  • func (fargate FargateProvider) PrepareKey(_ string) (crypto.PrivateKey, error)

Functions

func GetFargateConfig

func GetFargateConfig(configFile, metaEndpoint string, useRegionalSTS bool, account, region string) (*options.Config, *options.ConfigAccount, error)

func GetFargateData

func GetFargateData(metaEndPoint string) (string, string, string, error)

Types

type FargateProvider

type FargateProvider struct {
	Name string
}

func (FargateProvider) AttestationData

func (fargate FargateProvider) AttestationData(_ string, _ crypto.PrivateKey, _ *signature.SignatureInfo) (string, error)

func (FargateProvider) CloudAttestationData

func (fargate FargateProvider) CloudAttestationData(_, _, _ string) (string, error)

func (FargateProvider) GetAccessManagementProfileFromMeta

func (fargate FargateProvider) GetAccessManagementProfileFromMeta(_ string) (string, error)

func (FargateProvider) GetAccountDomainServiceFromMeta

func (fargate FargateProvider) GetAccountDomainServiceFromMeta(_ string) (string, string, string, error)

func (FargateProvider) GetAdditionalSshHostPrincipals

func (fargate FargateProvider) GetAdditionalSshHostPrincipals(_ string) (string, error)

func (FargateProvider) GetCsrDn

func (fargate FargateProvider) GetCsrDn() pkix.Name

func (FargateProvider) GetEmail

func (fargate FargateProvider) GetEmail(_ string) []string

func (FargateProvider) GetHostname

func (fargate FargateProvider) GetHostname(_ bool) string

GetHostname returns the hostname as per the provider

func (FargateProvider) GetName

func (fargate FargateProvider) GetName() string

GetName returns the name of the current provider

func (FargateProvider) GetRoleDnsNames

func (fargate FargateProvider) GetRoleDnsNames(_ *x509.Certificate, _ string) []string

func (FargateProvider) GetSanDns

func (fargate FargateProvider) GetSanDns(_ string, _ bool, _ bool, _ []string) []string

func (FargateProvider) GetSanIp

func (fargate FargateProvider) GetSanIp(_ map[string]bool, _ []net.IP, _ ip.Opts) []net.IP

func (FargateProvider) GetSanUri

func (fargate FargateProvider) GetSanUri(_ string, _ ip.Opts, _, _ string) []*url.URL

func (FargateProvider) GetSuffixes

func (fargate FargateProvider) GetSuffixes() []string

func (FargateProvider) PrepareKey

func (fargate FargateProvider) PrepareKey(_ string) (crypto.PrivateKey, error)