learcredop

Documentation

Overview

Copyright 2023 Jesus Ruiz. All rights reserved. Use of this source code is governed by an Apache 2.0 license that can be found in the LICENSE file.

Index

• func NewLogin(cfg *yaml.YAML, authenticate authenticate, ...) *login
• func SetupServer(cfg *yaml.YAML, storage Storage, logger *slog.Logger, wrapServer bool, ...) (chi.Router, error)
• func StarDictFromFiberRequest(c *fiber.Ctx) *starlark.Dict
• func StarDictFromHttpRequest(request *http.Request) (*starlark.Dict, error)
• type Decision
  • func (d Decision) String() string
• type PDP
  • func NewPDP(fileName string) (*PDP, error)
  • func (m PDP) HttpHandler(w http.ResponseWriter, r *http.Request)
  • func (m *PDP) ParseAndCompileFile() error
  • func (m PDP) TakeAuthnDecision(decision Decision, r *http.Request, credential string, ...) (bool, error)
• type Storage

Functions

func NewLogin

func NewLogin(
	cfg *yaml.YAML,
	authenticate authenticate,
	callback func(context.Context, string) string,
	issuerInterceptor *op.IssuerInterceptor,
) *login

func SetupServer

func SetupServer(cfg *yaml.YAML, storage Storage, logger *slog.Logger, wrapServer bool, extraOptions ...op.Option) (chi.Router, error)

SetupServer creates an OIDC server with the configured verifier URL

func StarDictFromFiberRequest

func StarDictFromFiberRequest(c *fiber.Ctx) *starlark.Dict

func StarDictFromHttpRequest

func StarDictFromHttpRequest(request *http.Request) (*starlark.Dict, error)

Types

type Decision

type Decision int

Decision can be Authenticate or Authorize

const Authenticate Decision = 1

const Authorize Decision = 2

func (Decision) String

func (d Decision) String() string

type PDP

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

PDP implements a simple Policy Decision Point in Starlark

func NewPDP

func NewPDP(fileName string) (*PDP, error)

func (PDP) HttpHandler

func (m PDP) HttpHandler(w http.ResponseWriter, r *http.Request)

func (*PDP) ParseAndCompileFile

func (m *PDP) ParseAndCompileFile() error

ParseAndCompileFile reads a file with Starlark code and compiles it, storing the resulting global dictionary for later usage. In particular, the compiled module should define two functions, one for athentication and the second for athorisation. ParseAndCompileFile can be called several times and will perform a new compilation every time, creating a new Thread and so the old ones will never be called again and eventually will be disposed.

func (PDP) TakeAuthnDecision

func (m PDP) TakeAuthnDecision(decision Decision, r *http.Request, credential string, protectedResource string) (bool, error)

TakeAuthnDecision is called when a decision should be taken for either Athentication or Authorization. The type of decision to evaluate is passed in the Decision argument. The rest of the arguments contain the information required for the decision. They are: - the Verifiable Credential with the information from the caller needed for the decision - the protected resource that the caller identified in the Credential wants to access

type Storage

type Storage interface {
	op.Storage
	// contains filtered or unexported methods
}