gdpr

type Builder func(opts *ServerOptions) Handler

type CallbackOptions struct {
	MaxAttempts     int
	Backoff         time.Duration
	ProcessorDomain string
	Client          *http.Client
	Signer          Signer
}

type CallbackRequest struct {
	ControllerId           string        `json:"controller_id"`
	ExpectedCompletionTime time.Time     `json:"expected_completion_time"`
	StatusCallbackUrl      string        `json:"status_callback_url"`
	SubjectRequestId       string        `json:"subject_request_id"`
	RequestStatus          RequestStatus `json:"request_status"`
	ResultsUrl             string        `json:"results_url"`
}

type CancellationResponse struct {
	ControllerId     string    `json:"controller_id"`
	SubjectRequestId string    `json:"subject_request_id"`
	ReceivedTime     time.Time `json:"ReceivedTime"`
	EncodedRequest   string    `json:"encoded_request"`
	ApiVersion       string    `json:"api_version"`
}

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

type ClientOptions struct {
	Endpoint string
	Verifier Verifier
	Client   *http.Client
}

type Controller interface {
	// Process a callback from a remote
	// processor.
	Callback(req *CallbackRequest) error
}

type DiscoveryResponse struct {
	ApiVersion                   string        `json:"api_version"`
	SupportedIdentities          []Identity    `json:"supported_identities"`
	SupportedSubjectRequestTypes []SubjectType `json:"supported_subject_request_types"`
	ProcessorCertificate         string        `json:"processor_certificate"`
}

type Error struct {
	Domain  string `json:"domain"`
	Reason  string `json:"reason"`
	Message string `json:"message"`
}

type ErrorResponse struct {
	Code    int     `json:"-"`
	Message string  `json:"-"`
	Errors  []Error `json:"-"`
}

type Handler func(resp io.Writer, req io.Reader, p httprouter.Params) error

type HandlerMap map[string]map[string]Builder

type Identity struct {
	Type   IdentityType   `json:"identity_type"`
	Format IdentityFormat `json:"identity_format"`
	Value  string         `json:"identity_value,omitempty"`
}

type IdentityFormat string

type IdentityType string

type KeyOptions struct {
	KeyPath  string
	KeyBytes []byte
	// Optional byte string to decrypt
	// a private key file.
	Password []byte
}

type NoopSigner struct{}

type NoopVerifier struct{}

type Processor interface {
	// Request accepts an incoming Request type
	// and is expected to process it in some way.
	Request(*Request) (*Response, error)
	// Status validates the status of an existing
	// request sent to this processor.
	Status(id string) (*StatusResponse, error)
	// Cancel prevents any further processing of
	// the Request.
	Cancel(id string) (*CancellationResponse, error)
}

type Request struct {
	SubjectRequestId   string      `json:"subject_request_id"`
	SubjectRequestType SubjectType `json:"subject_request_type"`
	SubmittedTime      time.Time   `json:"submitted_time"`
	ApiVersion         string      `json:"api_version"`
	StatusCallbackUrls []string    `json:"status_callback_urls"`
	SubjectIdentities  []Identity  `json:"subject_identities"`
	// TODO
	Extensions json.RawMessage `json:"extensions"`
}

type RequestStatus string

type Response struct {
	ControllerId           string    `json:"controller_id"`
	ExpectedCompletionTime time.Time `json:"expected_completion_time"`
	ReceivedTime           time.Time `json:"received_time"`
	EncodedRequest         string    `json:"encoded_request"`
	SubjectRequestId       string    `json:"subject_request_id"`
}

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

type ServerOptions struct {
	// Controller to process callback requests.
	Controller Controller
	// Processor to handle GDPR requests.
	Processor Processor
	// Signs all responses.
	Signer Signer
	// Verifies any incoming callbacks.
	Verifier Verifier
	// Array of identity types supported by
	// the server.
	Identities []Identity
	// Array of subject types supported by
	// the server.
	SubjectTypes []SubjectType
	// Optional map allowing the user to
	// override specific routes.
	HandlerMap HandlerMap
	// Processor domain of this server.
	ProcessorDomain string
	// Remote URL where the public certificate
	// of this server can be downloaded and used
	// to verify subsequent response payload
	ProcessorCertificateUrl string
}

type Signer interface {
	// Generate a signature for the digest
	Sign(body []byte) (string, error)
}

type StatusResponse struct {
	ControllerId           string        `json:"controller_id"`
	ExpectedCompletionTime time.Time     `json:"expected_completion_time"`
	SubjectRequestId       string        `json:"subject_request_id"`
	RequestStatus          RequestStatus `json:"request_status"`
	ApiVersion             string        `json:"api_version"`
	ResultsUrl             string        `json:"results_url"`
}

type SubjectType string

type Verifier interface {
	// return the underlying cerificate
	Cert() *x509.Certificate
	// verify the digest of the signature
	Verify(body []byte, signature string) error
}