generator

Documentation

Overview

Package generator defines a generator used to create certificate and private key.

Index

• type Closer
• type CreateOptions
• type FileWriter
  • func NewFileWriter(certfile, prikfile *os.File) *FileWriter
  • func NewFileWriterFromPaths(certfile, prikfile string) (*FileWriter, error)
  • func (fw *FileWriter) Close() error
  • func (fw *FileWriter) Write(cert, prik []byte) error
• type Generator
  • func New(opts ...Option) *Generator
  • func (g *Generator) CA() (ca *x509.Certificate, pkey crypto.PrivateKey)
  • func (g *Generator) Create(c *crt.Certificate) (cert []byte, pkey []byte, err error)
  • func (g *Generator) CreateAndWrite(w WriteCloser, c *crt.Certificate) error
  • func (g *Generator) CreateWithOptions(c *crt.Certificate, opts CreateOptions) (cert []byte, pkey []byte, err error)
  • func (g *Generator) SetCA(ca *x509.Certificate, pkey crypto.PrivateKey)
• type Option
  • func WithCA(ca *x509.Certificate, key crypto.PrivateKey) Option
  • func WithKeyGenerator(keyG key.Generator) Option
• type WriteCloser
• type Writer

Types

type Closer

type Closer interface {
	Close() error
}

Closer is the interface that wraps the basic Close method.

type CreateOptions

type CreateOptions struct {
	G        key.Generator
	KeyOpts  *key.MarshalOptions
	UseAsCA  bool
	AppendCA bool
}

CreateOptions defines options for Generator.Create. UseAsCA if true, the given crt.Certificate will be used as the CA certificate for the Generator. If the crt.Certificate is not CA type, UseAsCA will be ignored. AppendCA if true, the CA certificate of the Generator will append to the result.

type FileWriter

type FileWriter struct {
	// contains filtered or unexported fields
}

FileWriter implements Writer interface.

func NewFileWriter

func NewFileWriter(certfile, prikfile *os.File) *FileWriter

NewFileWriter creates a new FileWriter with certificate *os.File and private key *os.File.

func NewFileWriterFromPaths

func NewFileWriterFromPaths(certfile, prikfile string) (*FileWriter, error)

NewFileWriterFromPaths creates a new FileWriter with the given certificate and private key paths.

func (*FileWriter) Close

func (fw *FileWriter) Close() error

Close implements Closer interface.

func (*FileWriter) Write

func (fw *FileWriter) Write(cert, prik []byte) error

Write implements Writer interface.

type Generator

type Generator struct {
	// contains filtered or unexported fields
}

Generator is the main structure of a generator.

func New

func New(opts ...Option) *Generator

New return a new certificate generator.

func (*Generator) CA

func (g *Generator) CA() (ca *x509.Certificate, pkey crypto.PrivateKey)

CA returns the CA pair of the Generator.

func (*Generator) Create

func (g *Generator) Create(c *crt.Certificate) (cert []byte, pkey []byte, err error)

Create creates a new X.509 v3 certificate and private key based on a template.

func (*Generator) CreateAndWrite

func (g *Generator) CreateAndWrite(w WriteCloser, c *crt.Certificate) error

CreateAndWrite creates a new X.509 v3 certificate and private key, then execute the Writer.Write.

func (*Generator) CreateWithOptions

func (g *Generator) CreateWithOptions(c *crt.Certificate, opts CreateOptions) (cert []byte, pkey []byte, err error)

CreateWithOptions creates a new X.509 v3 certificate and private key based on a template with the given CreateOptions.

func (*Generator) SetCA

func (g *Generator) SetCA(ca *x509.Certificate, pkey crypto.PrivateKey)

SetCA is used to set the CA pair of the Generator.

type Option

type Option interface {
	// contains filtered or unexported methods
}

Option defines optional parameters for initializing the generator structure.

func WithCA

func WithCA(ca *x509.Certificate, key crypto.PrivateKey) Option

WithCA is used to set the CA pair of the Generator.

func WithKeyGenerator

func WithKeyGenerator(keyG key.Generator) Option

WithKeyGenerator is used to set the private key generator of the Generator.

type WriteCloser

type WriteCloser interface {
	Writer
	Closer
}

WriteCloser is the interface that groups the basic Write and Close methods.

type Writer

type Writer interface {
	// Write writes certificate and private key
	Write(cert, prik []byte) error
}

Writer is the interface that wraps the basic Write method.