certpg

README

PostgreSQL schema

Documentation

Index

• Constants
• Variables
• func ScanCertificate(row Scanner, cert *Certificate) (err error)
• func ScanDnsname(row Scanner, p *Dnsname) error
• func ScanDnsnamesView(row Scanner, dnsname *DnsnamesView) (err error)
• func ScanIdent(row Scanner, ident *Ident) error
• func ScanLogEntry(row Scanner, entry *LogEntry) (err error)
• type CertPG
  • func New(ctx context.Context, cd bwlimit.ContextDialer, db *sql.DB, prefix string) (cdb *CertPG, err error)
  • func (cdb *CertPG) BackfillStream(ctx context.Context, ls *certstream.LogStream)
  • func (cdb *CertPG) Close() error
  • func (cdb *CertPG) Entry(ctx context.Context, le *certstream.LogEntry) (err error)
  • func (cdb *CertPG) Estimate(table string) (estimate float64, err error)
  • func (cdb *CertPG) GetCertificateByHash(ctx context.Context, hash []byte) (cert *certjson.Certificate, err error)
  • func (cdb *CertPG) GetCertificateByID(ctx context.Context, id int64) (cert *certjson.Certificate, err error)
  • func (cdb *CertPG) GetCertificateByLogEntry(ctx context.Context, entry *LogEntry) (cert *certjson.Certificate, err error)
  • func (cdb *CertPG) LogError(err error, msg string, args ...any) error
  • func (cdb *CertPG) Operator(ctx context.Context, lo *certstream.LogOperator) (err error)
  • func (cdb *CertPG) Stream(ctx context.Context, ls *certstream.LogStream) (err error)
• type Certificate
• type Dnsname
• type DnsnamesView
• type Ident
• type LogEntry
• type Scanner

Constants

const SelectDnsnameLike = `SELECT * FROM CERTDB_dnsnames WHERE dnsname LIKE $1;`

const SelectEstimate = `SELECT reltuples AS estimate FROM pg_class WHERE relname = $1;`

const SelectMaxIndex = `SELECT MAX(logindex) AS logindex FROM CERTDB_entry WHERE stream = $1;`

const SelectMinIndex = `SELECT MIN(logindex) AS logindex FROM CERTDB_entry WHERE stream = $1;`

Variables

var BulkRange = int64(4096)

var FunctionName string

var FunctionOperatorID string

var FunctionStreamID string

var ProcedureCreateSchema string

var ProcedureNewEntry string

var SelectGaps string

Functions

func ScanCertificate

func ScanCertificate(row Scanner, cert *Certificate) (err error)

func ScanDnsname

func ScanDnsname(row Scanner, p *Dnsname) error

func ScanDnsnamesView

func ScanDnsnamesView(row Scanner, dnsname *DnsnamesView) (err error)

func ScanIdent

func ScanIdent(row Scanner, ident *Ident) error

func ScanLogEntry

func ScanLogEntry(row Scanner, entry *LogEntry) (err error)

Types

type CertPG

type CertPG struct {
	*sql.DB
	certstream.Logger
	Backfill              bool                // if true, fill in missing entries in database
	bwlimit.ContextDialer                     // if not nil, ContextDialer used for backfilling
	Pfx                   func(string) string // prefix replacer
	// contains filtered or unexported fields
}

CertPG integrates with sql.DB to manage certificate stream data for a PostgreSQL database

func New

func New(ctx context.Context, cd bwlimit.ContextDialer, db *sql.DB, prefix string) (cdb *CertPG, err error)

New creates a CertPG and creates the needed tables and indices if they don't exist.

func (*CertPG) BackfillStream

func (cdb *CertPG) BackfillStream(ctx context.Context, ls *certstream.LogStream)

func (*CertPG) Close

func (cdb *CertPG) Close() error

Close frees resources used.

func (*CertPG) Entry

func (cdb *CertPG) Entry(ctx context.Context, le *certstream.LogEntry) (err error)

func (*CertPG) Estimate

func (cdb *CertPG) Estimate(table string) (estimate float64, err error)

func (*CertPG) GetCertificateByHash

func (cdb *CertPG) GetCertificateByHash(ctx context.Context, hash []byte) (cert *certjson.Certificate, err error)

func (*CertPG) GetCertificateByID

func (cdb *CertPG) GetCertificateByID(ctx context.Context, id int64) (cert *certjson.Certificate, err error)

func (*CertPG) GetCertificateByLogEntry

func (cdb *CertPG) GetCertificateByLogEntry(ctx context.Context, entry *LogEntry) (cert *certjson.Certificate, err error)

func (*CertPG) LogError

func (cdb *CertPG) LogError(err error, msg string, args ...any) error

func (*CertPG) Operator

func (cdb *CertPG) Operator(ctx context.Context, lo *certstream.LogOperator) (err error)

func (*CertPG) Stream

func (cdb *CertPG) Stream(ctx context.Context, ls *certstream.LogStream) (err error)

type Certificate

type Certificate struct {
	Id         int64
	NotBefore  time.Time
	NotAfter   time.Time
	CommonName string
	SubjectID  int
	IssuerID   int
	Sha256     []byte
	PreCert    bool
}

type Dnsname

type Dnsname struct {
	Dnsname string
	CertID  int64
}

type DnsnamesView

type DnsnamesView struct {
	CertID    int64
	DNSName   string
	NotBefore time.Time
	Idna      bool
	Valid     bool
	PreCert   bool
	Issuer    string
	Subject   string
	Crtsh     string
}

type Ident

type Ident struct {
	Id           int
	Organization string
	Province     string
	Country      string
}

type LogEntry

type LogEntry struct {
	Seen     time.Time // CT log entry timestamp
	LogIndex int64     // CT log index for the stream
	CertID   int64     // database ID of cert
	StreamID int       // database ID of stream
}

type Scanner

type Scanner interface {
	Scan(dest ...any) error
}