Commit ee57ab53 authored by Sietse Ringers's avatar Sietse Ringers
Browse files

Document server and library packages

parent ea876c59
// Package core is the core of the IRMA server library, allowing IRMA verifiers, issuers
// or attribute-based signature applications to perform IRMA sessions with irmaclient instances
// (i.e. the IRMA app). It exposes a small interface to expose to other programming languages
// through cgo. It is used by the irmarequestor package but otherwise not meant for use in Go.
package core
import (
......
// Package irmarequestor is a library that allows IRMA verifiers,
// issuers or attribute-based signature applications to perform
// IRMA sessions with irmaclient instances (i.e. the IRMA app). It
// exposes functions for handling IRMA sessions and a HTTP handler
// that handles the sessions with the irmaclient.
package irmarequestor
import (
......
// Executable for the irmaserver.
package main
import (
......
// Package irmaserver is a server allowing IRMA verifiers, issuers or attribute-based signature applications (the requestor) to perform IRMA sessions with irmaclient instances (i.e. the IRMA app). It exposes a RESTful protocol with which the requestor can start and manage the session as well as HTTP endpoints for the irmaclient.
package irmaserver
import (
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment