Commit 72c6e2bc authored by Sietse Ringers's avatar Sietse Ringers
Browse files

Commenting session request structs

parent 4d8466cb
......@@ -93,12 +93,16 @@ type ServerJwt struct {
IssuedAt Timestamp `json:"iat"`
// RequestorBaseRequest contains fields present in all RequestorRequest types
// with which the requestor configures an IRMA session.
type RequestorBaseRequest struct {
ResultJwtValidity int `json:"validity"` // Validity of session result JWT in seconds
ClientTimeout int `json:"timeout"` // Wait this many seconds for the IRMA app to connect before the session times out
CallbackUrl string `json:"callbackUrl"` // URL to post session result to
// RequestorRequest is the message with which requestors start an IRMA session. It contains a
// SessionRequest instance for the irmaclient along with extra fields in a RequestorBaseRequest.
type RequestorRequest interface {
SessionRequest() SessionRequest
......@@ -186,7 +190,7 @@ func (r *IdentityProviderRequest) Base() RequestorBaseRequest {
return r.RequestorBaseRequest
// SessionRequest is an IRMA session.
// SessionRequest instances contain all information the irmaclient needs to perform an IRMA session.
type SessionRequest interface {
GetNonce() *big.Int
......@@ -167,6 +167,10 @@ func WriteString(w http.ResponseWriter, str string) {
// ParseSessionRequest attempts to parse the input as an irma.RequestorRequest instance, accepting (skipping "irma.")
// - RequestorRequest instances directly (ServiceProviderRequest, SignatureRequestorRequest, IdentityProviderRequest)
// - SessionRequest instances (DisclosureRequest, SignatureRequest, IssuanceRequest)
// - JSON representations ([]byte or string) of any of the above.
func ParseSessionRequest(request interface{}) (irma.RequestorRequest, error) {
switch r := request.(type) {
case irma.RequestorRequest:
......@@ -214,7 +218,9 @@ func tryUnmarshalJson(bts []byte, attempts []irma.Validator) (irma.Validator, er
return nil, errors.New("")
// LocalIP returns the IP address of one of the (non-loopback) network interfaces
func LocalIP() (string, error) {
// Based on from
ifaces, err := net.Interfaces()
if err != nil {
return "", err
......@@ -48,6 +48,8 @@ func New(conf *server.Configuration) (*Server, error) {
// StartSession starts an IRMA session, running the handler on completion, if specified.
// The session token (the second return parameter) can be used in GetSessionResult()
// and CancelSession().
// The request parameter can be an irma.RequestorRequest, or an irma.SessionRequest, or a
// ([]byte or string) JSON representation of one of those (for more details, see server.ParseSessionRequest().)
func StartSession(request interface{}, handler SessionHandler) (*irma.Qr, string, error) {
return s.StartSession(request, handler)
Supports Markdown
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