isgasho/nuts-auth

Nuts Auth. All auth related operations.

Nuts Auth Service

The auth module is written in Go and should be part of nuts-go as an engine.

Dependencies

This projects is using go modules, so version > 1.12 is recommended. 1.10 would be a minimum.

Running tests

Tests can be run by executing

go test ./...

Generating code

oapi-codegen -generate server,types -package api docs/_static/nuts-auth.yaml > api/generated.go

Generating Mock

When making changes to the client interface run the following command to regenerate the mock:

mockgen -destination=mock/mock_client.go -package=mock -source=pkg/auth.go

Building

This project is part of https://github.com/nuts-foundation/nuts-go. If you do however would like a binary, just use go build.

README

The readme is auto-generated from a template and uses the documentation to fill in the blanks.

./generate_readme.sh

This script uses rst_include which is installed as part of the dependencies for generating the documentation.

Documentation

To generate the documentation, you'll need python3, sphinx and a bunch of other stuff. See nuts-documentation-development-documentation The documentation can be build by running

/docs $ make html

The resulting html will be available from docs/_build/html/index.html

Configuration

The following configuration parameters are available:

Key	Default	Description
actingPartyCn		The acting party Common name used in contracts
address	localhost:1323	Interface and port for http server to bind to, default: localhost:1323
enableCORS irmaConfigPath	false	Set if you want to allow CORS requests. This is useful when you want browsers to directly communicate with the nuts node. path to IRMA config folder. If not set, a tmp folder is created.
irmaSchemeManager mode publicUrl	pbdf	The IRMA schemeManager to use for attributes. Can be either 'pbdf' or 'irma-demo', default: pbdf server or client, when client it does not start any services so that CLI commands can be used. Public URL which can be reached by a users IRMA client
skipAutoUpdateIrmaSchemas	false	set if you want to skip the auto download of the irma schemas every 60 minutes.

As with all other properties for nuts-go, they can be set through yaml:

yaml

auth:

publicUrl: "https://nuts.nl"

as commandline property

shell

./nuts --auth.publicUrl https://nuts.nl

Or by using environment variables

shell

NUTS_AUTH_PUBLIC_URL=https://nuts.nl ./nuts