identity

README

Vanadium Identity Service

This package and its sub-packages implement the identity service at https://dev.v.io/auth.

The design is described here: https://vanadium.github.io/designdocs/identity-service.html

Documentation

Overview

Package identity defines interfaces for Vanadium identity providers.

Index

• Constants
• Variables
• type BlessingRootResponse
  • func (x BlessingRootResponse) VDLIsZero() bool
  • func (x *BlessingRootResponse) VDLRead(dec vdl.Decoder) error
  • func (BlessingRootResponse) VDLReflect(struct{ ... })
  • func (x BlessingRootResponse) VDLWrite(enc vdl.Encoder) error
• type MacaroonBlesserClientMethods
• type MacaroonBlesserClientStub
  • func MacaroonBlesserClient(name string) MacaroonBlesserClientStub
• type MacaroonBlesserServerMethods
• type MacaroonBlesserServerStub
  • func MacaroonBlesserServer(impl MacaroonBlesserServerMethods) MacaroonBlesserServerStub
• type MacaroonBlesserServerStubMethods

Constants

const SeekBlessingsRoute = oauth.SeekBlessingsRoute

Variables

var MacaroonBlesserDesc rpc.InterfaceDesc = descMacaroonBlesser

MacaroonBlesserDesc describes the MacaroonBlesser interface.

Types

type BlessingRootResponse

type BlessingRootResponse struct {
	// Names of the blessings.
	Names []string
	// Base64 der-encoded public key.
	PublicKey string
}

BlessingRootResponse is the struct representing the JSON response provided by the "blessing-root" route of the identity service.

func (BlessingRootResponse) VDLIsZero

func (x BlessingRootResponse) VDLIsZero() bool

func (*BlessingRootResponse) VDLRead

func (x *BlessingRootResponse) VDLRead(dec vdl.Decoder) error

func (BlessingRootResponse) VDLReflect

func (BlessingRootResponse) VDLReflect(struct {
	Name string `vdl:"v.io/x/ref/services/identity.BlessingRootResponse"`
})

func (BlessingRootResponse) VDLWrite

func (x BlessingRootResponse) VDLWrite(enc vdl.Encoder) error

type MacaroonBlesserClientMethods

type MacaroonBlesserClientMethods interface {
	// Bless uses the provided macaroon (which contains email and caveats)
	// to return a blessing for the client.
	Bless(_ *context.T, macaroon string, _ ...rpc.CallOpt) (blessing security.Blessings, _ error)
}

MacaroonBlesserClientMethods is the client interface containing MacaroonBlesser methods.

MacaroonBlesser returns a blessing given the provided macaroon string.

type MacaroonBlesserClientStub

type MacaroonBlesserClientStub interface {
	MacaroonBlesserClientMethods
	rpc.UniversalServiceMethods
}

MacaroonBlesserClientStub adds universal methods to MacaroonBlesserClientMethods.

func MacaroonBlesserClient

func MacaroonBlesserClient(name string) MacaroonBlesserClientStub

MacaroonBlesserClient returns a client stub for MacaroonBlesser.

type MacaroonBlesserServerMethods

type MacaroonBlesserServerMethods interface {
	// Bless uses the provided macaroon (which contains email and caveats)
	// to return a blessing for the client.
	Bless(_ *context.T, _ rpc.ServerCall, macaroon string) (blessing security.Blessings, _ error)
}

MacaroonBlesserServerMethods is the interface a server writer implements for MacaroonBlesser.

MacaroonBlesser returns a blessing given the provided macaroon string.

type MacaroonBlesserServerStub

type MacaroonBlesserServerStub interface {
	MacaroonBlesserServerStubMethods
	// Describe the MacaroonBlesser interfaces.
	Describe__() []rpc.InterfaceDesc
}

MacaroonBlesserServerStub adds universal methods to MacaroonBlesserServerStubMethods.

func MacaroonBlesserServer

func MacaroonBlesserServer(impl MacaroonBlesserServerMethods) MacaroonBlesserServerStub

MacaroonBlesserServer returns a server stub for MacaroonBlesser. It converts an implementation of MacaroonBlesserServerMethods into an object that may be used by rpc.Server.

type MacaroonBlesserServerStubMethods

type MacaroonBlesserServerStubMethods MacaroonBlesserServerMethods

MacaroonBlesserServerStubMethods is the server interface containing MacaroonBlesser methods, as expected by rpc.Server. There is no difference between this interface and MacaroonBlesserServerMethods since there are no streaming methods.