Skip to content

Latest commit

 

History

History
115 lines (67 loc) · 5.62 KB

README.md

File metadata and controls

115 lines (67 loc) · 5.62 KB
Raw

ZACA

ZACA

License GoDoc

ZACA is a PKI developed based on cloudflare cfssl,Public key infrastructure (PKI) governs the issuance of digital certificates to protect sensitive data, provide unique digital identities for users, devices and applications and secure end-to-end communications.

Zaca includes the following components：

  1. TLS service, as the CA center, is used for certificate issuance, revocation, signature and other operations.
  2. API services, as some API services for certificate management.
  3. OCSP service is a service that queries the online status of certificates and has been signed by OCSP.
  4. SDK component, which is used for other services to access the CA SDK as a toolkit for certificate issuance and automatic rotation.

How the Certificate Creation Process Works

The certificate creation process relies heavily on asymmetric encryption and works as follows:

  • A private key is created and the corresponding public key gets computed
  • The CA requests any identifying attributes of the private key owner and vets that information
  • The public key and identifying attributes get encoded into a Certificate Signing Request (CSR)
  • The CSR is signed by the key owner to prove possession of that private key
  • The issuing CA validates the request and signs the certificate with the CA’s own private key

image-20220425164057905

Anyone can use the public portion of a certificate to verify that it was actually issued by the CA by confirming who owns the private key used to sign the certificate. And, assuming they deem that CA trustworthy, they can verify that anything they send to the certificate holder will actually go to the intended recipient and that anything signed using that certificate holder’s private key was indeed signed by that person/device.

One important part of this process to note is that the CA itself has its own private key and corresponding public key, which creates the need for CA hierarchies.

How CA Hierarchies and Root CAs Create Layers of Trust

Since each CA has a certificate of its own, layers of trust get created through CA hierarchies — in which CAs issue certificates for other CAs. However, this process is not circular, as there is ultimately a root certificate. Normally, certificates have an issuer and a subject as two separate parties, but these are the same parties for root CAs, meaning that root certificates are self-signed. As a result, people must inherently trust the root certificate authority to trust any certificates that trace back to it.

image-20220425164028072

ZACA overall architecture and working mode

image-20220425165623191

Building

Building cfssl requires a working Go 1.12+ installation.

$ git clone [email protected]:ztalab/ZACA.git
$ cd ZACA
$ make

You can set GOOS and GOARCH environment variables to allow Go to cross-compile alternative platforms.

The resulting binaries will be in the bin folder:

$ tree bin
bin
├── zaca

Configuration reference

When ZACA starts each service, it needs to rely on some configurations, and the dependent configuration information has two configuration methods:

configuration file:

The configuration file is in the project root directory：conf.yml ,The file format is standard yaml format, which can be used as a reference。

environment variable:

In the project root directory：.env.example, The file describes how to configure some settings through environment variables.

Priority:

The configuration priority of environment variables is higher than the configuration in the configuration file.

Service Installation

TLS service

TLS service is used to issue certificates through controlIS_KEYMANAGER_SELF_SIGN Environment variable to control whether to start as Root CA.

  • Started as root CA, TLS service will self sign certificate.
  • When starting as an intermediate CA, the TLS service needs to request the root CA signing certificate as its own CA certificate.

Start command：zaca tls，Default listening port 8081

OCSP service

OCSP online certificate status is used to query the certificate status information. OCSP returns the certificate online status information to quickly check whether the certificate has expired, whether it has been revoked and so on.

Start command：zaca ocsp，Default listening port 8082

API service

Provide CA center API service, which can be accessed after the service is startedhttp://localhost:8080/swagger/index.html，View API documentation.

Start command：zaca api，Default listening port 8080

SDK Installation

$ go get github.com/ztalab/zaca-sdk

The classic usage of the ZACA SDK is that the client and the server use the certificate issued by the CA center for encrypted communication. The following is the usage of the sdk between the client and the server.

See：Demo