domain

Documentation

Overview

* Nuts registry * Copyright (C) 2020. Nuts community * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see <https://www.gnu.org/licenses/>. *

* Nuts registry * Copyright (C) 2020. Nuts community * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see <https://www.gnu.org/licenses/>. *

* Nuts registry * Copyright (C) 2020. Nuts community * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see <https://www.gnu.org/licenses/>. *

* Nuts registry * Copyright (C) 2020. Nuts community * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see <https://www.gnu.org/licenses/>. *

* Nuts registry * Copyright (C) 2020. Nuts community * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see <https://www.gnu.org/licenses/>. *

Index

• Constants
• func GetEventTypes() []events.EventType
• func NewCertificateEventHandler(trustStore cert.TrustStore) events.TrustStore
• func OrganizationEventMatcher(vendorID core.PartyID, organizationID core.PartyID) events.EventMatcher
• func VendorEventMatcher(vendorID core.PartyID) events.EventMatcher
• type RegisterEndpointEvent
• type RegisterVendorEvent
  • func (r *RegisterVendorEvent) PostProcessUnmarshal(_ events.Event) error
• type VendorClaimEvent
  • func (v VendorClaimEvent) PostProcessUnmarshal(event events.Event) error

Constants

const RegisterEndpoint events.EventType = "RegisterEndpointEvent"

RegisterEndpoint event type

const RegisterVendor events.EventType = "RegisterVendorEvent"

RegisterVendor event type

const VendorClaim events.EventType = "VendorClaimEvent"

VendorClaim event type

Functions

func GetEventTypes

func GetEventTypes() []events.EventType

func NewCertificateEventHandler

func NewCertificateEventHandler(trustStore cert.TrustStore) events.TrustStore

NewCertificateEventHandler constructs a new handler that verifies certificates in events and adds them to the truststore if necessary.

func OrganizationEventMatcher

func OrganizationEventMatcher(vendorID core.PartyID, organizationID core.PartyID) events.EventMatcher

OrganizationEventMatcher returns an EventMatcher which matches the VendorClaimEvent which registered the organization with the specified ID for the specified vendor (also by ID).

func VendorEventMatcher

func VendorEventMatcher(vendorID core.PartyID) events.EventMatcher

VendorEventMatcher returns an EventMatcher which matches the RegisterVendorEvent for the vendor with the specified ID.

Types

type RegisterEndpointEvent

type RegisterEndpointEvent struct {
	Organization core.PartyID      `json:"organization"`
	URL          string            `json:"URL"`
	EndpointType string            `json:"endpointType"`
	Identifier   types.EndpointID  `json:"identifier"`
	Status       string            `json:"status"`
	Properties   map[string]string `json:"properties,omitempty"`
}

RegisterEndpointEvent event

type RegisterVendorEvent

type RegisterVendorEvent struct {
	Identifier core.PartyID  `json:"identifier"`
	Name       string        `json:"name"`
	Domain     string        `json:"domain,omitempty"`
	Keys       []interface{} `json:"keys,omitempty"`
}

RegisterVendorEvent event

func (*RegisterVendorEvent) PostProcessUnmarshal

func (r *RegisterVendorEvent) PostProcessUnmarshal(_ events.Event) error

type VendorClaimEvent

type VendorClaimEvent struct {
	VendorID       core.PartyID `json:"vendorIdentifier"`
	OrganizationID core.PartyID `json:"orgIdentifier"`
	OrgName        string       `json:"orgName"`
	// OrgKeys is a list of JWKs which are used to
	// 1. encrypt data to be decrypted by the organization,
	// 2. sign consent JWTs,
	// 3. sign organization related events (e.g. endpoint registration).
	OrgKeys []interface{} `json:"orgKeys,omitempty"`
	Start   time.Time     `json:"start"`
	End     *time.Time    `json:"end,omitempty"`
}

VendorClaimEvent event

func (VendorClaimEvent) PostProcessUnmarshal

func (v VendorClaimEvent) PostProcessUnmarshal(event events.Event) error