presentproof

Documentation

Index

• func WithPresentation(msg *Presentation) presentproof.Opt
• func WithProposePresentation(msg *ProposePresentation) presentproof.Opt
• func WithRequestPresentation(msg *RequestPresentation) presentproof.Opt
• type Action
• type Client
  • func New(ctx Provider) (*Client, error)
  • func (c *Client) AcceptPresentation(piID string) error
  • func (c *Client) AcceptProposePresentation(piID string, msg *RequestPresentation) error
  • func (c *Client) AcceptRequestPresentation(piID string, msg *Presentation) error
  • func (c *Client) Actions() ([]Action, error)
  • func (c *Client) DeclinePresentation(piID, reason string) error
  • func (c *Client) DeclineProposePresentation(piID, reason string) error
  • func (c *Client) DeclineRequestPresentation(piID, reason string) error
  • func (c *Client) NegotiateRequestPresentation(piID string, msg *ProposePresentation) error
  • func (c *Client) SendProposePresentation(msg *ProposePresentation, myDID, theirDID string) error
  • func (c *Client) SendRequestPresentation(msg *RequestPresentation, myDID, theirDID string) error
• type Presentation
• type ProposePresentation
• type ProtocolService
• type Provider
• type RequestPresentation

Functions

func WithPresentation

func WithPresentation(msg *Presentation) presentproof.Opt

WithPresentation allows providing Presentation message Use this option to respond to RequestPresentation

func WithProposePresentation

func WithProposePresentation(msg *ProposePresentation) presentproof.Opt

WithProposePresentation allows providing ProposePresentation message Use this option to respond to RequestPresentation

func WithRequestPresentation

func WithRequestPresentation(msg *RequestPresentation) presentproof.Opt

WithRequestPresentation allows providing RequestPresentation message Use this option to respond to ProposePresentation

Types

type Action

type Action presentproof.Action

Action contains helpful information about action

type Client

type Client struct {
	service.Event
	// contains filtered or unexported fields
}

Client enable access to presentproof API https://github.com/hyperledger/aries-rfcs/tree/master/features/0037-present-proof

func New

func New(ctx Provider) (*Client, error)

New returns new instance of the presentproof client

func (*Client) AcceptPresentation

func (c *Client) AcceptPresentation(piID string) error

AcceptPresentation is used by the Verifier to accept a presentation.

func (*Client) AcceptProposePresentation

func (c *Client) AcceptProposePresentation(piID string, msg *RequestPresentation) error

AcceptProposePresentation is used when the Verifier is willing to accept the propose presentation.

func (*Client) AcceptRequestPresentation

func (c *Client) AcceptRequestPresentation(piID string, msg *Presentation) error

AcceptRequestPresentation is used by the Prover is to accept a presentation request.

func (*Client) Actions

func (c *Client) Actions() ([]Action, error)

Actions returns pending actions that have yet to be executed or cancelled.

func (*Client) DeclinePresentation

func (c *Client) DeclinePresentation(piID, reason string) error

DeclinePresentation is used by the Verifier to decline a presentation.

func (*Client) DeclineProposePresentation

func (c *Client) DeclineProposePresentation(piID, reason string) error

DeclineProposePresentation is used when the Verifier does not want to accept the propose presentation.

func (*Client) DeclineRequestPresentation

func (c *Client) DeclineRequestPresentation(piID, reason string) error

DeclineRequestPresentation is used when the Prover does not want to accept the request presentation.

func (*Client) NegotiateRequestPresentation

func (c *Client) NegotiateRequestPresentation(piID string, msg *ProposePresentation) error

NegotiateRequestPresentation is used by the Prover to counter a presentation request they received with a proposal.

func (*Client) SendProposePresentation

func (c *Client) SendProposePresentation(msg *ProposePresentation, myDID, theirDID string) error

SendProposePresentation is used by the Prover to send a propose presentation.

func (*Client) SendRequestPresentation

func (c *Client) SendRequestPresentation(msg *RequestPresentation, myDID, theirDID string) error

SendRequestPresentation is used by the Verifier to send a request presentation.

type Presentation

type Presentation presentproof.Presentation

Presentation is a response to a RequestPresentation message and contains signed presentations.

type ProposePresentation

type ProposePresentation presentproof.ProposePresentation

ProposePresentation is an optional message sent by the Prover to the verifier to initiate a proof presentation process, or in response to a request-presentation message when the Prover wants to propose using a different presentation format.

type ProtocolService

type ProtocolService interface {
	service.DIDComm
	Actions() ([]presentproof.Action, error)
	ActionContinue(piID string, opt presentproof.Opt) error
	ActionStop(piID string, err error) error
}

ProtocolService defines the presentproof service.

type Provider

type Provider interface {
	Service(id string) (interface{}, error)
}

Provider contains dependencies for the protocol and is typically created by using aries.Context()

type RequestPresentation

type RequestPresentation presentproof.RequestPresentation

RequestPresentation describes values that need to be revealed and predicates that need to be fulfilled.