certstream

package module

v0.0.1 Latest Latest Go to latest Published: Oct 17, 2024 License: MIT Imports: 19 Imported by: 1

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/linkdata/certstream

Links

Open Source Insights

README ¶

CertStream

Small library wrapping github.com/google/certificate-transparency-go.

Adds no new dependencies.

Documentation ¶

Overview ¶

Code generated by mkver at Thu Oct 17 12:31:09 2024 DO NOT EDIT. branch "main", build 19

Index ¶

Constants
Variables
func DefaultLogStreamInit(op *loglist3.Operator, log *loglist3.Log) (httpClient *http.Client, startIndex int64)
func GetLogList(ctx context.Context, httpClient *http.Client, listUrl string) (logList *loglist3.LogList, err error)
func OperatorDomain(urlString string) string
type CertStream
- func New() *CertStream
- func (cs *CertStream) Start(ctx context.Context, logList *loglist3.LogList) (entryCh <-chan *LogEntry, err error)
type LogEntry
type LogStream
- func NewLogStream(cs *CertStream, httpClient *http.Client, startIndex int64, ...) (ls *LogStream, err error)
- func (ls *LogStream) Run(ctx context.Context, entryCh chan<- *LogEntry)
- func (ls *LogStream) String() string
type LogStreamInitFn

Constants ¶

View Source

const PkgName = "CertStream"

View Source

const PkgVersion = "v0.0.0-main.19"

Variables ¶

View Source

var DefaultHttpClient = &http.Client{
	Timeout: 10 * time.Second,
	Transport: &http.Transport{
		TLSHandshakeTimeout:   30 * time.Second,
		ResponseHeaderTimeout: 30 * time.Second,
		MaxIdleConnsPerHost:   10,
		DisableKeepAlives:     false,
		MaxIdleConns:          100,
		IdleConnTimeout:       90 * time.Second,
		ExpectContinueTimeout: 1 * time.Second,
	},
}

Functions ¶

func DefaultLogStreamInit ¶

func DefaultLogStreamInit(op *loglist3.Operator, log *loglist3.Log) (httpClient *http.Client, startIndex int64)

DefaultLogStreamInit returns (DefaultHttpClient, -1) for all operators and logs where the log is usable.

func GetLogList ¶

func GetLogList(ctx context.Context, httpClient *http.Client, listUrl string) (logList *loglist3.LogList, err error)

GetLogList fetches a CT log list from the given listUrl. Usually you would pass loglist3.AllLogListURL for the listUrl.

func OperatorDomain ¶

func OperatorDomain(urlString string) string

OperatorDomain returns the TLD+1 given an URL.

Types ¶

type CertStream ¶

type CertStream struct {
	LogStreamInit LogStreamInitFn
	BatchSize     int
	ParallelFetch int
}

func New ¶

func New() *CertStream

New returns a CertStream with reasonable defaults.

func (*CertStream) Start ¶

func (cs *CertStream) Start(ctx context.Context, logList *loglist3.LogList) (entryCh <-chan *LogEntry, err error)

Start returns a channel to read results from. If logList is nil, we fetch the list from loglist3.AllLogListURL using DefaultHttpClient.

type LogEntry ¶

type LogEntry struct {
	*LogStream
	Err          error           // error from RawLogEntryFromLeaf or ToLogEntry, or nil
	RawLogEntry  *ct.RawLogEntry // may be nil in case of error
	*ct.LogEntry                 // may be nil in case of error
}

func (*LogEntry) Cert ¶

func (le *LogEntry) Cert() (cert *x509.Certificate)

Cert returns the cert from LogEntry.X509Cert or LogEntry.Precert.TBSCertificate, or nil.

func (*LogEntry) DNSNames ¶

func (le *LogEntry) DNSNames() (names []string)

DNSNames returns Cert().DNSNames if possible.

func (*LogEntry) Index ¶

func (le *LogEntry) Index() (index int64)

Index returns the log index or -1 if none is available.

func (*LogEntry) String ¶

func (le *LogEntry) String() (s string)

type LogStream ¶

type LogStream struct {
	*CertStream
	*loglist3.Operator
	*loglist3.Log
	*client.LogClient
	OperatorDomain string // e.g. "letsencrypt.org" or "googleapis.com"
	// contains filtered or unexported fields
}

func NewLogStream ¶

func NewLogStream(cs *CertStream, httpClient *http.Client, startIndex int64, op *loglist3.Operator, log *loglist3.Log) (ls *LogStream, err error)

func (*LogStream) Run ¶

func (ls *LogStream) Run(ctx context.Context, entryCh chan<- *LogEntry)

func (*LogStream) String ¶

func (ls *LogStream) String() string

type LogStreamInitFn ¶

type LogStreamInitFn func(op *loglist3.Operator, log *loglist3.Log) (httpClient *http.Client, startIndex int64)

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
cmd
certstream command

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL