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 ¶
const SeekBlessingsRoute = oauth.SeekBlessingsRoute
Variables ¶
var MacaroonBlesserDesc rpc.InterfaceDesc = descMacaroonBlesser
MacaroonBlesserDesc describes the MacaroonBlesser interface.
Functions ¶
This section is empty.
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"` })
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
}
MacaroonBlesserClientStub embeds MacaroonBlesserClientMethods and is a placeholder for additional management operations.
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
// DescribeInterfaces 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.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Command identityd runs a daemon HTTP server that uses OAuth to create security.Blessings objects.
|
Command identityd runs a daemon HTTP server that uses OAuth to create security.Blessings objects. |
|
Package identitylib implements a test identityd service registered using the v.io/x/lib/gosh library.
|
Package identitylib implements a test identityd service registered using the v.io/x/lib/gosh library. |
|
internal
|
|
|
identityd_test
Command identityd_test runs a daemon HTTP server that uses OAuth to create security.Blessings objects.
|
Command identityd_test runs a daemon HTTP server that uses OAuth to create security.Blessings objects. |
|
oauth
Package oauth implements an http.Handler that has two main purposes listed below: (1) Uses OAuth to authenticate and then renders a page that displays all the blessings that were provided for that Google user.
|
Package oauth implements an http.Handler that has two main purposes listed below: (1) Uses OAuth to authenticate and then renders a page that displays all the blessings that were provided for that Google user. |
|
revocation
Package revocation provides tools to create and manage revocation caveats.
|
Package revocation provides tools to create and manage revocation caveats. |
|
server
HTTP server that uses OAuth to create security.Blessings objects.
|
HTTP server that uses OAuth to create security.Blessings objects. |
|
util
Package util implements miscellaneous utility functions needed by the identity HTTP server.
|
Package util implements miscellaneous utility functions needed by the identity HTTP server. |