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

• Variables
• func GetAttestationData(domain, service, account, region, taskId string, useRegionalSTS bool, ...) (*attestation.AttestationData, error)
• func GetECSFargateData(metaEndPoint string) (string, string, string, error)
• func GetRoleCertificate(ztsUrl, svcKeyFile, svcCertFile string, opts *options.Options, ...) bool
• func RefreshInstance(data []*attestation.AttestationData, ztsUrl string, opts *options.Options, ...) error
• func RegisterInstance(data []*attestation.AttestationData, ztsUrl string, opts *options.Options, ...) error

Variables

var (
	ECSMetaEndPoint = "http://169.254.170.2"
)

Functions

func GetAttestationData

func GetAttestationData(domain, service, account, region, taskId string, useRegionalSTS bool, sysLogger io.Writer) (*attestation.AttestationData, error)

func GetECSFargateData

func GetECSFargateData(metaEndPoint string) (string, string, string, error)

func GetRoleCertificate

func GetRoleCertificate(ztsUrl, svcKeyFile, svcCertFile string, opts *options.Options, sysLogger io.Writer) bool

func RefreshInstance

func RefreshInstance(data []*attestation.AttestationData, ztsUrl string, opts *options.Options, region string, sysLogger io.Writer) error

func RegisterInstance

func RegisterInstance(data []*attestation.AttestationData, ztsUrl string, opts *options.Options, region string, sysLogger io.Writer) error