signers

package

v0.0.0-...-6c3212e Latest Latest Go to latest Published: Mar 6, 2024 License: Apache-2.0 Imports: 8 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/choria-io/aaasvc

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func SetSigner(s Signer)
func SignHandler(params operations.PostSignParams) middleware.Responder
func SignRequest(req []byte, token string, signature string) (bool, []byte, error)
type Signer

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrorCtr = prometheus.NewCounterVec(prometheus.CounterOpts{
		Name: "choria_aaa_signer_errors",
		Help: "Total number of requests that could not be signed",
	}, []string{"site", "signer"})

	AllowedCtr = prometheus.NewCounterVec(prometheus.CounterOpts{
		Name: "choria_aaa_signer_allowed",
		Help: "Total number of requests that were allowed by the authorizer",
	}, []string{"site", "signer"})

	DenyCtr = prometheus.NewCounterVec(prometheus.CounterOpts{
		Name: "choria_aaa_signer_denied",
		Help: "Total number of requests that were denied by the authorizer",
	}, []string{"site", "signer"})

	InvalidTokenCtr = prometheus.NewCounterVec(prometheus.CounterOpts{
		Name: "choria_aaa_signer_invalid_token",
		Help: "Total number of requests that contained invalid tokens",
	}, []string{"site", "signer"})
)

Functions ¶

func SetSigner ¶

func SetSigner(s Signer)

SetSigner sets the signer to use

func SignHandler ¶

func SignHandler(params operations.PostSignParams) middleware.Responder

SignHandler is a HTTP middleware handler for signing messages using the signer set by SetSigner

func SignRequest ¶

func SignRequest(req []byte, token string, signature string) (bool, []byte, error)

SignRequest signs a request based on a token using the configured signer

Types ¶

type Signer ¶

type Signer interface {
	// Sign takes a HTTP request and sign it if desired, else setting errors in the sr
	Sign(req *models.SignRequest) *models.SignResponse

	// SignRequest signs req based on token
	SignRequest(req []byte, token string, signature string) (bool, []byte, error)

	// SetAuditors add auditors to be called after signing actions
	SetAuditors(...auditors.Auditor)

	// SetAuthorizer sets the authorizer to use
	SetAuthorizer(authorizers.Authorizer)
}

Signer is a interface that describes software capable of signing a request

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
basicjwt Package basicjwt is a signer that parse a JWT token and approves requests based on the claims within it.	Package basicjwt is a signer that parse a JWT token and approves requests based on the claims within it.

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