package authority import ( "context" "errors" "fmt" "go.step.sm/linkedca" authPolicy "github.com/smallstep/certificates/authority/policy" policy "github.com/smallstep/certificates/policy" ) type policyErrorType int const ( _ policyErrorType = iota AdminLockOut StoreFailure ReloadFailure ConfigurationFailure EvaluationFailure InternalFailure ) type PolicyError struct { Typ policyErrorType Err error } func (p *PolicyError) Error() string { return p.Err.Error() } func (a *Authority) GetAuthorityPolicy(ctx context.Context) (*linkedca.Policy, error) { a.adminMutex.Lock() defer a.adminMutex.Unlock() p, err := a.adminDB.GetAuthorityPolicy(ctx) if err != nil { return nil, err } return p, nil } func (a *Authority) CreateAuthorityPolicy(ctx context.Context, adm *linkedca.Admin, p *linkedca.Policy) (*linkedca.Policy, error) { a.adminMutex.Lock() defer a.adminMutex.Unlock() if err := a.checkAuthorityPolicy(ctx, adm, p); err != nil { return nil, &PolicyError{ Typ: AdminLockOut, Err: err, } } if err := a.adminDB.CreateAuthorityPolicy(ctx, p); err != nil { return nil, &PolicyError{ Typ: StoreFailure, Err: err, } } if err := a.reloadPolicyEngines(ctx); err != nil { return nil, &PolicyError{ Typ: ReloadFailure, Err: fmt.Errorf("error reloading policy engines when creating authority policy: %w", err), } } return p, nil // TODO: return the newly stored policy } func (a *Authority) UpdateAuthorityPolicy(ctx context.Context, adm *linkedca.Admin, p *linkedca.Policy) (*linkedca.Policy, error) { a.adminMutex.Lock() defer a.adminMutex.Unlock() if err := a.checkAuthorityPolicy(ctx, adm, p); err != nil { return nil, err } if err := a.adminDB.UpdateAuthorityPolicy(ctx, p); err != nil { return nil, &PolicyError{ Typ: StoreFailure, Err: err, } } if err := a.reloadPolicyEngines(ctx); err != nil { return nil, &PolicyError{ Typ: ReloadFailure, Err: fmt.Errorf("error reloading policy engines when updating authority policy %w", err), } } return p, nil // TODO: return the updated stored policy } func (a *Authority) RemoveAuthorityPolicy(ctx context.Context) error { a.adminMutex.Lock() defer a.adminMutex.Unlock() if err := a.adminDB.DeleteAuthorityPolicy(ctx); err != nil { return &PolicyError{ Typ: StoreFailure, Err: err, } } if err := a.reloadPolicyEngines(ctx); err != nil { return &PolicyError{ Typ: ReloadFailure, Err: fmt.Errorf("error reloading policy engines when deleting authority policy %w", err), } } return nil } func (a *Authority) checkAuthorityPolicy(ctx context.Context, currentAdmin *linkedca.Admin, p *linkedca.Policy) error { // no policy and thus nothing to evaluate; return early if p == nil { return nil } // get all current admins from the database allAdmins, err := a.adminDB.GetAdmins(ctx) if err != nil { return &PolicyError{ Typ: InternalFailure, Err: fmt.Errorf("error retrieving admins: %w", err), } } return a.checkPolicy(ctx, currentAdmin, allAdmins, p) } func (a *Authority) checkProvisionerPolicy(ctx context.Context, currentAdmin *linkedca.Admin, provName string, p *linkedca.Policy) error { // no policy and thus nothing to evaluate; return early if p == nil { return nil } // get all admins for the provisioner allProvisionerAdmins, ok := a.admins.LoadByProvisioner(provName) if !ok { return &PolicyError{ Typ: InternalFailure, Err: errors.New("error retrieving admins by provisioner"), } } return a.checkPolicy(ctx, currentAdmin, allProvisionerAdmins, p) } // checkPolicy checks if a new or updated policy configuration results in the user // locking themselves or other admins out of the CA. func (a *Authority) checkPolicy(ctx context.Context, currentAdmin *linkedca.Admin, otherAdmins []*linkedca.Admin, p *linkedca.Policy) error { // convert the policy; return early if nil policyOptions := policyToCertificates(p) if policyOptions == nil { return nil } engine, err := authPolicy.NewX509PolicyEngine(policyOptions.GetX509Options()) if err != nil { return &PolicyError{ Typ: ConfigurationFailure, Err: err, } } // when an empty X.509 policy is provided, the resulting engine is nil // and there's no policy to evaluate. if engine == nil { return nil } // TODO(hs): Provide option to force the policy, even when the admin subject would be locked out? // check if the admin user that instructed the authority policy to be // created or updated, would still be allowed when the provided policy // would be applied. sans := []string{currentAdmin.GetSubject()} if err := isAllowed(engine, sans); err != nil { return err } // loop through admins to verify that none of them would be // locked out when the new policy were to be applied. Returns // an error with a message that includes the admin subject that // would be locked out. for _, adm := range otherAdmins { sans = []string{adm.GetSubject()} if err := isAllowed(engine, sans); err != nil { return err } } // TODO(hs): mask the error message for non-super admins? return nil } func isAllowed(engine authPolicy.X509Policy, sans []string) error { var ( allowed bool err error ) if allowed, err = engine.AreSANsAllowed(sans); err != nil { var policyErr *policy.NamePolicyError isNamePolicyError := errors.As(err, &policyErr) if isNamePolicyError && policyErr.Reason == policy.NotAuthorizedForThisName { return &PolicyError{ Typ: AdminLockOut, Err: fmt.Errorf("the provided policy would lock out %s from the CA. Please update your policy to include %s as an allowed name", sans, sans), } } return &PolicyError{ Typ: EvaluationFailure, Err: err, } } if !allowed { return &PolicyError{ Typ: AdminLockOut, Err: fmt.Errorf("the provided policy would lock out %s from the CA. Please update your policy to include %s as an allowed name", sans, sans), } } return nil } func policyToCertificates(p *linkedca.Policy) *authPolicy.Options { // return early if p == nil { return nil } // prepare full policy struct opts := &authPolicy.Options{ X509: &authPolicy.X509PolicyOptions{ AllowedNames: &authPolicy.X509NameOptions{}, DeniedNames: &authPolicy.X509NameOptions{}, }, SSH: &authPolicy.SSHPolicyOptions{ Host: &authPolicy.SSHHostCertificateOptions{ AllowedNames: &authPolicy.SSHNameOptions{}, DeniedNames: &authPolicy.SSHNameOptions{}, }, User: &authPolicy.SSHUserCertificateOptions{ AllowedNames: &authPolicy.SSHNameOptions{}, DeniedNames: &authPolicy.SSHNameOptions{}, }, }, } // fill x509 policy configuration if p.X509 != nil { if p.X509.Allow != nil { if p.X509.Allow.Dns != nil { opts.X509.AllowedNames.DNSDomains = p.X509.Allow.Dns } if p.X509.Allow.Ips != nil { opts.X509.AllowedNames.IPRanges = p.X509.Allow.Ips } if p.X509.Allow.Emails != nil { opts.X509.AllowedNames.EmailAddresses = p.X509.Allow.Emails } if p.X509.Allow.Uris != nil { opts.X509.AllowedNames.URIDomains = p.X509.Allow.Uris } } if p.X509.Deny != nil { if p.X509.Deny.Dns != nil { opts.X509.DeniedNames.DNSDomains = p.X509.Deny.Dns } if p.X509.Deny.Ips != nil { opts.X509.DeniedNames.IPRanges = p.X509.Deny.Ips } if p.X509.Deny.Emails != nil { opts.X509.DeniedNames.EmailAddresses = p.X509.Deny.Emails } if p.X509.Deny.Uris != nil { opts.X509.DeniedNames.URIDomains = p.X509.Deny.Uris } } } // fill ssh policy configuration if p.Ssh != nil { if p.Ssh.Host != nil { if p.Ssh.Host.Allow != nil { if p.Ssh.Host.Allow.Dns != nil { opts.SSH.Host.AllowedNames.DNSDomains = p.Ssh.Host.Allow.Dns } if p.Ssh.Host.Allow.Ips != nil { opts.SSH.Host.AllowedNames.IPRanges = p.Ssh.Host.Allow.Ips } if p.Ssh.Host.Allow.Principals != nil { opts.SSH.Host.AllowedNames.Principals = p.Ssh.Host.Allow.Principals } } if p.Ssh.Host.Deny != nil { if p.Ssh.Host.Deny.Dns != nil { opts.SSH.Host.DeniedNames.DNSDomains = p.Ssh.Host.Deny.Dns } if p.Ssh.Host.Deny.Ips != nil { opts.SSH.Host.DeniedNames.IPRanges = p.Ssh.Host.Deny.Ips } if p.Ssh.Host.Deny.Principals != nil { opts.SSH.Host.DeniedNames.Principals = p.Ssh.Host.Deny.Principals } } } if p.Ssh.User != nil { if p.Ssh.User.Allow != nil { if p.Ssh.User.Allow.Emails != nil { opts.SSH.User.AllowedNames.EmailAddresses = p.Ssh.User.Allow.Emails } if p.Ssh.User.Allow.Principals != nil { opts.SSH.User.AllowedNames.Principals = p.Ssh.User.Allow.Principals } } if p.Ssh.User.Deny != nil { if p.Ssh.User.Deny.Emails != nil { opts.SSH.User.DeniedNames.EmailAddresses = p.Ssh.User.Deny.Emails } if p.Ssh.User.Deny.Principals != nil { opts.SSH.User.DeniedNames.Principals = p.Ssh.User.Deny.Principals } } } } return opts }