https://github.com/alonza0314/cert-go
This package is used for signing the cert in customize.
https://github.com/alonza0314/cert-go
cert-go certificate cobra cobra-cli golang pki pki-tools self-signed-certificate
Last synced: 2 months ago
JSON representation
This package is used for signing the cert in customize.
- Host: GitHub
- URL: https://github.com/alonza0314/cert-go
- Owner: Alonza0314
- Created: 2024-11-13T16:07:19.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-03-03T13:52:21.000Z (3 months ago)
- Last Synced: 2025-03-03T14:36:09.155Z (3 months ago)
- Topics: cert-go, certificate, cobra, cobra-cli, golang, pki, pki-tools, self-signed-certificate
- Language: Go
- Homepage:
- Size: 66.4 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# cert-go
This package is a golang command line tool implementation of self-signing certificates.
Also, we expected to link third party CA certificates to generate certificates in the future.
## Develop Environment
|Type|Version|
|-|-|
|OS|ubuntu 22.04.5|
|Golang|go1.22.5 linux/amd64|
## Usage
> [!NOTE]
> If the target file (certificate, csr, private key) is existed, the function will not create it and directly return an error, cert/csr/private key already exists.
1. Prepare the destination directory for the private key, certificate, and CSR. This step is required for all the following steps.
2. Modify the `cfg.yml` file to set the appropriate values(you can use the `defaultCfg.yml` file as your template).
[Click here to see the default configuration file](./defaultCfg.yml)
3. Import the `certgo` package in your code.
```go
import "github.com/Alonza0314/cert-go"
```
4. For create private key, you need to specify the path of the destination file. Then, use this function:
```go
CreatePrivateKey(keyPath string) (*ecdsa.PrivateKey, error)
```
The return value is the private key in `*ecdsa.PrivateKey` type.
5. For create csr, you need to specify the [certificate structure](./model/model_certificate.go). You can use `ReadYamlFileToStruct` function to read the configuration file and convert it to the certificate structure.
```go
util.ReadYamlFileToStruct(yamlPath string, v interface{}) error
```
Then, use this function:
```go
CreateCsr(cfg model.Certificate) (*x509.CertificateRequest, error)
```
The return value is the csr in `*x509.CertificateRequest` type.
NOTICE:
- If the private key is not existed, the function will automatically create one in default.
6. For sign certificate, you need to specify the yaml file path of the CA configuration. Then, use these functions for different types of certificates:
```go
SignRootCertificate(yamlPath string) (*x509.Certificate, error)
SignIntermediateCertificate(yamlPath string) (*x509.Certificate, error)
SignServerCertificate(yamlPath string) (*x509.Certificate, error)
SignClientCertificate(yamlPath string) (*x509.Certificate, error)
```
The return value is the signed certificate in `*x509.Certificate` type.
NOTICE:
- If the private key is not existed, the function will automatically create one in default.
- If the csr is not existed, the function will automatically create one in default.
7. In the end, it is expected to see the private key, certificate, and csr in the destination directory.
## Example
[Click here to see the example](./example/)
## Test
```bash
go test ./... -v
```
## Command Line Tool
### Build by Yourself(in root directory)
```bash
./build_cmd.sh
```
Then, you can find the executable file in the `build` directory.
### Use Directly
You can download the binary file from the release page and execute it directly.
[Go to the release page to download the binary file](https://github.com/Alonza0314/cert-go/releases)
### Command Line Tool Usage
[Click here to see the command line tool usage in detail](./cmd/README.md)
## About Me
[Click here to know more about me](https://alonza0314.github.io/)