Skip to content

About

EST client and embeddable server library for Go: RFC 7030 with the RFC 8951 clarifications, server-side key generation, CSR attributes and TPM 2.0 enrollment. Supports TLS-SRP password sign-in (RFC 5054), password renewal, ML-DSA keys and certificates, HSM and TPM client keys

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

1 star

Watchers

0 watching

Forks

Latest commit

 

History

334 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

go-pki-est

GitHub Release Go Reference License Tests Supply chain OpenSSF Scorecard

Go library for Enrollment over Secure Transport (EST), the certificate enrollment protocol defined in RFC 7030. It provides:

  • an EST client library
  • an http.Handler that serves EST in front of your CA (NewRouter and the CA interface)
  • estclient, a command line client built on the library
  • estserver, a server with a mock CA for testing and development

Contents

Install

go get github.com/misiektoja/go-pki-est

The package name is est. Requires Go 1.27.3 or newer.

The command line tools install with:

go install github.com/misiektoja/go-pki-est/cmd/estclient@latest
go install github.com/misiektoja/go-pki-est/cmd/estserver@latest

Scope

Standard Coverage Enabled by
RFC 7030 EST /cacerts, /csrattrs, /simpleenroll, /simplereenroll and /serverkeygen, with or without an additional path segment Always
RFC 7030 section 3.5 tls-unique proof of possession over TLS 1.2 Client.SigningKey. The CA checks the value
RFC 7030 section 2.3 Renewal with a password or token instead of the certificate ServerConfig.PasswordRenewal
RFC 7030 section 3.3.3 and RFC 5054 TLS-SRP sign-in without certificates Client.SRPUsername and a go-tls-srp listener
RFC 6750 Bearer tokens Client.BearerToken and ServerConfig.CheckBearerToken
RFC 8951 Whitespace in base64 and the Content-Transfer-Encoding header ignored Always
TPM 2.0 credential protection /tpmenroll, an operation outside RFC 7030 CA.TPMEnroll

ML-DSA keys work for enrollment, renewal over TLS 1.3 and server-generated keys. Composite ML-DSA and SLH-DSA requests need a signature hook, because Go cannot verify them. /fullcmc is not implemented.

Getting started

Enroll a key with an EST server that asks for a password:

client := &est.Client{
	Host:           "est.example.com:8443",
	ExplicitAnchor: anchor, // *x509.CertPool with the root of the EST server
	Username:       "device-1",
	Password:       "one-time-secret",
}
cert, err := client.Enroll(ctx, csr) // csr is a parsed *x509.CertificateRequest
if err != nil {
	log.Fatal(err)
}

To serve EST, implement the CA interface and pass it to est.NewRouter, which returns an http.Handler for your TLS server.

Getting started runs estserver and enrolls, renews and gets a server-generated key with estclient, then shows the same from Go.

Documentation

Full documentation is at misiektoja.github.io/go-pki-est.

The package documentation on pkg.go.dev describes every exported type.

Limitations

  • No /fullcmc and no CMS error responses.
  • The router does not check the tls-unique value or revocation. The CA does.
  • TLS 1.3 has no tls-unique value, so ML-DSA renewals carry no binding.
  • Composite ML-DSA and SLH-DSA need host hooks and cannot renew over TLS.
  • estserver issues to anyone and is for testing only.

Known limitations explains each gap.

Credits

This project began as a fork of globalsign/est by GMO GlobalSign. The protocol implementation, both command line tools and the test server come from that project. The first fixes made here were offered upstream in globalsign/est#59 to globalsign/est#66.

This fork is maintained separately so fixes and new features ship in its own releases without waiting for upstream review. Changes that suit upstream are still offered there. NOTICE records the attribution.

Support

SUPPORT.md says where to ask questions and what to include in a bug report. Check Troubleshooting first. Report vulnerabilities privately as SECURITY.md describes. The Contributing Guide lists the development checks and the Code of conduct applies to every project space. CHANGELOG.md records the changes in each release and DEPENDENCIES.md lists the third-party modules and their licenses.

License

MIT License. See LICENSE and NOTICE.

About

EST client and embeddable server library for Go: RFC 7030 with the RFC 8951 clarifications, server-side key generation, CSR attributes and TPM 2.0 enrollment. Supports TLS-SRP password sign-in (RFC 5054), password renewal, ML-DSA keys and certificates, HSM and TPM client keys

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages