README
¶
go-phorce/dolly
GO packages for building web apps in go-phorce
Requirements
- GoLang 1.16+
- SoftHSM 2.6+
Contribution
make allcomplete build and testmake testrun the testsmake testshortruns the tests skipping the end-to-end tests and the code coverage reportingmake covtestruns the tests with end-to-end and the code coverage reportingmake coverageview the code coverage results from the last make test run.make generateruns go generate to update any code generated filesmake fmtruns go fmt on the project.make lintruns the go linter on the project.
run make all once, then run make build or make test as needed.
First run:
make all
Tests:
make test
Optionally run golang race detector with test targets by setting RACE flag:
make test RACE=true
Review coverage report:
make covtest coverage
Directories
¶
| Path | Synopsis |
|---|---|
|
algorithms
|
|
|
math
Package math implements basic operations on various types
|
Package math implements basic operations on various types |
|
slices
Package slices provides additional slice functions on common slice types
|
Package slices provides additional slice functions on common slice types |
|
throttle
Package throttle provides functionality to limit the frequency with which code is called Throttling is of the Trigger() method and depends on the parameters passed (period, trailing).
|
Package throttle provides functionality to limit the frequency with which code is called Throttling is of the Trigger() method and depends on the parameters passed (period, trailing). |
|
Package audit provides a definition of an audit event and an standard inteface to register events being triggered.
|
Package audit provides a definition of an audit event and an standard inteface to register events being triggered. |
|
log
Package log provides an implmentation of Auditer that writes to local disk files
|
Package log provides an implmentation of Auditer that writes to local disk files |
|
cmd
|
|
|
dollypki
Command dollypki is a command-line utility for managing HSM keys and creating certificates
|
Command dollypki is a command-line utility for managing HSM keys and creating certificates |
|
dollypki/cli
Package cli provides common code for building a command line control for the service
|
Package cli provides common code for building a command line control for the service |
|
Package ctl provides common code for building a command line control app that works via https calls to a service
|
Package ctl provides common code for building a command line control app that works via https calls to a service |
|
Package fileutil provides utilities for file operations
|
Package fileutil provides utilities for file operations |
|
Package tasks is task scheduling package which lets you run Go functions periodically at pre-determined interval using a simple, human-friendly syntax.
|
Package tasks is task scheduling package which lets you run Go functions periodically at pre-determined interval using a simple, human-friendly syntax. |
|
Package testify provides helpers for testing
|
Package testify provides helpers for testing |
|
servefiles
Package servefiles provides a way to mock a HTTP server endpoint by providing response payloads from the disk
|
Package servefiles provides a way to mock a HTTP server endpoint by providing response payloads from the disk |
|
authz
Package authz provides an implemention of http authorization where specific URI (or URI's and their children) are allowed access by a set of roles the caller can supply a way to map from a request to a role name.
|
Package authz provides an implemention of http authorization where specific URI (or URI's and their children) are allowed access by a set of roles the caller can supply a way to map from a request to a role name. |
|
identity
Package identity extracts the callers contextual identity information from the HTTP/TLS requests and exposes them for access via the generalized go context model.
|
Package identity extracts the callers contextual identity information from the HTTP/TLS requests and exposes them for access via the generalized go context model. |
|
marshal
Package marshal provides some common handlers for encoding or decoding json
|
Package marshal provides some common handlers for encoding or decoding json |
|
Package xlog has slight modifications on the original code, adding ability to specify log lever per package, and exposing Logger interface, not an implementation structure.
|
Package xlog has slight modifications on the original code, adding ability to specify log lever per package, and exposing Logger interface, not an implementation structure. |
|
logrotate
Package logrotate implements additional functionality for io writers & closers
|
Package logrotate implements additional functionality for io writers & closers |
|
xpki
|
|
|
armor
Package armor implements OpenPGP ASCII Armor, see RFC 4880.
|
Package armor implements OpenPGP ASCII Armor, see RFC 4880. |
|
authority
Package authority contains the Certification Authority.
|
Package authority contains the Certification Authority. |
|
certutil
Package certutil provides utilities to work with certificates.
|
Package certutil provides utilities to work with certificates. |
|
crypto11
Package crypto11 allows for access cryptographic keys from PKCS#11 using Go crypto API.
|
Package crypto11 allows for access cryptographic keys from PKCS#11 using Go crypto API. |
Click to show internal directories.
Click to hide internal directories.