services/identity/identity.vdl.go - release.go.x.ref - Git at Google

 // This file was auto-generated by the veyron vdl tool.
 // Source: identity.vdl

 // Package identity defines services for identity providers in the veyron ecosystem.
 package identity

 import (
 	// The non-user imports are prefixed with "_gen_" to prevent collisions.
 	_gen_context "veyron2/context"
 	_gen_ipc "veyron2/ipc"
 	_gen_naming "veyron2/naming"
 	_gen_rt "veyron2/rt"
 	_gen_vdlutil "veyron2/vdl/vdlutil"
 	_gen_wiretype "veyron2/wiretype"
 )

 // TODO(bprosnitz) Remove this line once signatures are updated to use typevals.
 // It corrects a bug where _gen_wiretype is unused in VDL pacakges where only bootstrap types are used on interfaces.
 const _ = _gen_wiretype.TypeIDInvalid

 // OAuthBlesser exchanges OAuth authorization codes OR access tokens for
 // an email address from an OAuth-based identity provider and uses the email
 // address obtained to bless the client.
 //
 // OAuth is described in RFC 6749 (http://tools.ietf.org/html/rfc6749),
 // though the Google implementation also has informative documentation at
 // https://developers.google.com/accounts/docs/OAuth2
 //
 // WARNING: There is no binding between the channel over which the
 // authorization code or access token was obtained (typically https)
 // and the channel used to make the RPC (a veyron virtual circuit).
 // Thus, if Mallory possesses the authorization code or access token
 // associated with Alice's account, she may be able to obtain a blessing
 // with Alice's name on it.
 //
 // TODO(ashankar,toddw): Once the "OneOf" type becomes available in VDL,
 // then the "any" should be replaced by:
 // OneOf<wire.ChainPublicID, []wire.ChainPublicID>
 // where wire is from:
 // import "veyron2/security/wire"
 // OAuthBlesser is the interface the client binds and uses.
 // OAuthBlesser_ExcludingUniversal is the interface without internal framework-added methods
 // to enable embedding without method collisions.  Not to be used directly by clients.
 type OAuthBlesser_ExcludingUniversal interface {
 	// BlessUsingAuthorizationCode exchanges the provided authorization code
 	// for an access token and then uses that access token to obtain an
 	// email address.
 	//
 	// The redirect URL used to obtain the authorization code must also
 	// be provided.
 	BlessUsingAuthorizationCode(ctx _gen_context.T, authcode string, redirecturl string, opts ..._gen_ipc.CallOpt) (reply _gen_vdlutil.Any, err error)
 	// BlessUsingAccessToken uses the provided access token to obtain the email
 	// address and returns a blessing.
 	BlessUsingAccessToken(ctx _gen_context.T, token string, opts ..._gen_ipc.CallOpt) (reply _gen_vdlutil.Any, err error)
 }
 type OAuthBlesser interface {
 	_gen_ipc.UniversalServiceMethods
 	OAuthBlesser_ExcludingUniversal
 }

 // OAuthBlesserService is the interface the server implements.
 type OAuthBlesserService interface {

 	// BlessUsingAuthorizationCode exchanges the provided authorization code
 	// for an access token and then uses that access token to obtain an
 	// email address.
 	//
 	// The redirect URL used to obtain the authorization code must also
 	// be provided.
 	BlessUsingAuthorizationCode(context _gen_ipc.ServerContext, authcode string, redirecturl string) (reply _gen_vdlutil.Any, err error)
 	// BlessUsingAccessToken uses the provided access token to obtain the email
 	// address and returns a blessing.
 	BlessUsingAccessToken(context _gen_ipc.ServerContext, token string) (reply _gen_vdlutil.Any, err error)
 }

 // BindOAuthBlesser returns the client stub implementing the OAuthBlesser
 // interface.
 //
 // If no _gen_ipc.Client is specified, the default _gen_ipc.Client in the
 // global Runtime is used.
 func BindOAuthBlesser(name string, opts ..._gen_ipc.BindOpt) (OAuthBlesser, error) {
 	var client _gen_ipc.Client
 	switch len(opts) {
 	case 0:
 		client = _gen_rt.R().Client()
 	case 1:
 		switch o := opts[0].(type) {
 		case _gen_ipc.Client:
 			client = o
 		default:
 			return nil, _gen_vdlutil.ErrUnrecognizedOption
 		}
 	default:
 		return nil, _gen_vdlutil.ErrTooManyOptionsToBind
 	}
 	stub := &clientStubOAuthBlesser{client: client, name: name}

 	return stub, nil
 }

 // NewServerOAuthBlesser creates a new server stub.
 //
 // It takes a regular server implementing the OAuthBlesserService
 // interface, and returns a new server stub.
 func NewServerOAuthBlesser(server OAuthBlesserService) interface{} {
 	return &ServerStubOAuthBlesser{
 		service: server,
 	}
 }

 // clientStubOAuthBlesser implements OAuthBlesser.
 type clientStubOAuthBlesser struct {
 	client _gen_ipc.Client
 	name   string
 }

 func (__gen_c *clientStubOAuthBlesser) BlessUsingAuthorizationCode(ctx _gen_context.T, authcode string, redirecturl string, opts ..._gen_ipc.CallOpt) (reply _gen_vdlutil.Any, err error) {
 	var call _gen_ipc.Call
 	if call, err = __gen_c.client.StartCall(ctx, __gen_c.name, "BlessUsingAuthorizationCode", []interface{}{authcode, redirecturl}, opts...); err != nil {
 		return
 	}
 	if ierr := call.Finish(&reply, &err); ierr != nil {
 		err = ierr
 	}
 	return
 }

 func (__gen_c *clientStubOAuthBlesser) BlessUsingAccessToken(ctx _gen_context.T, token string, opts ..._gen_ipc.CallOpt) (reply _gen_vdlutil.Any, err error) {
 	var call _gen_ipc.Call
 	if call, err = __gen_c.client.StartCall(ctx, __gen_c.name, "BlessUsingAccessToken", []interface{}{token}, opts...); err != nil {
 		return
 	}
 	if ierr := call.Finish(&reply, &err); ierr != nil {
 		err = ierr
 	}
 	return
 }

 func (__gen_c *clientStubOAuthBlesser) UnresolveStep(ctx _gen_context.T, opts ..._gen_ipc.CallOpt) (reply []string, err error) {
 	var call _gen_ipc.Call
 	if call, err = __gen_c.client.StartCall(ctx, __gen_c.name, "UnresolveStep", nil, opts...); err != nil {
 		return
 	}
 	if ierr := call.Finish(&reply, &err); ierr != nil {
 		err = ierr
 	}
 	return
 }

 func (__gen_c *clientStubOAuthBlesser) Signature(ctx _gen_context.T, opts ..._gen_ipc.CallOpt) (reply _gen_ipc.ServiceSignature, err error) {
 	var call _gen_ipc.Call
 	if call, err = __gen_c.client.StartCall(ctx, __gen_c.name, "Signature", nil, opts...); err != nil {
 		return
 	}
 	if ierr := call.Finish(&reply, &err); ierr != nil {
 		err = ierr
 	}
 	return
 }

 func (__gen_c *clientStubOAuthBlesser) GetMethodTags(ctx _gen_context.T, method string, opts ..._gen_ipc.CallOpt) (reply []interface{}, err error) {
 	var call _gen_ipc.Call
 	if call, err = __gen_c.client.StartCall(ctx, __gen_c.name, "GetMethodTags", []interface{}{method}, opts...); err != nil {
 		return
 	}
 	if ierr := call.Finish(&reply, &err); ierr != nil {
 		err = ierr
 	}
 	return
 }

 // ServerStubOAuthBlesser wraps a server that implements
 // OAuthBlesserService and provides an object that satisfies
 // the requirements of veyron2/ipc.ReflectInvoker.
 type ServerStubOAuthBlesser struct {
 	service OAuthBlesserService
 }

 func (__gen_s *ServerStubOAuthBlesser) GetMethodTags(call _gen_ipc.ServerCall, method string) ([]interface{}, error) {
 	// TODO(bprosnitz) GetMethodTags() will be replaces with Signature().
 	// Note: This exhibits some weird behavior like returning a nil error if the method isn't found.
 	// This will change when it is replaced with Signature().
 	switch method {
 	case "BlessUsingAuthorizationCode":
 		return []interface{}{}, nil
 	case "BlessUsingAccessToken":
 		return []interface{}{}, nil
 	default:
 		return nil, nil
 	}
 }

 func (__gen_s *ServerStubOAuthBlesser) Signature(call _gen_ipc.ServerCall) (_gen_ipc.ServiceSignature, error) {
 	result := _gen_ipc.ServiceSignature{Methods: make(map[string]_gen_ipc.MethodSignature)}
 	result.Methods["BlessUsingAccessToken"] = _gen_ipc.MethodSignature{
 		InArgs: []_gen_ipc.MethodArgument{
 			{Name: "token", Type: 3},
 		},
 		OutArgs: []_gen_ipc.MethodArgument{
 			{Name: "blessing", Type: 65},
 			{Name: "err", Type: 66},
 		},
 	}
 	result.Methods["BlessUsingAuthorizationCode"] = _gen_ipc.MethodSignature{
 		InArgs: []_gen_ipc.MethodArgument{
 			{Name: "authcode", Type: 3},
 			{Name: "redirecturl", Type: 3},
 		},
 		OutArgs: []_gen_ipc.MethodArgument{
 			{Name: "blessing", Type: 65},
 			{Name: "err", Type: 66},
 		},
 	}

 	result.TypeDefs = []_gen_vdlutil.Any{
 		_gen_wiretype.NamedPrimitiveType{Type: 0x1, Name: "anydata", Tags: []string(nil)}, _gen_wiretype.NamedPrimitiveType{Type: 0x1, Name: "error", Tags: []string(nil)}}

 	return result, nil
 }

 func (__gen_s *ServerStubOAuthBlesser) UnresolveStep(call _gen_ipc.ServerCall) (reply []string, err error) {
 	if unresolver, ok := __gen_s.service.(_gen_ipc.Unresolver); ok {
 		return unresolver.UnresolveStep(call)
 	}
 	if call.Server() == nil {
 		return
 	}
 	var published []string
 	if published, err = call.Server().Published(); err != nil || published == nil {
 		return
 	}
 	reply = make([]string, len(published))
 	for i, p := range published {
 		reply[i] = _gen_naming.Join(p, call.Name())
 	}
 	return
 }

 func (__gen_s *ServerStubOAuthBlesser) BlessUsingAuthorizationCode(call _gen_ipc.ServerCall, authcode string, redirecturl string) (reply _gen_vdlutil.Any, err error) {
 	reply, err = __gen_s.service.BlessUsingAuthorizationCode(call, authcode, redirecturl)
 	return
 }

 func (__gen_s *ServerStubOAuthBlesser) BlessUsingAccessToken(call _gen_ipc.ServerCall, token string) (reply _gen_vdlutil.Any, err error) {
 	reply, err = __gen_s.service.BlessUsingAccessToken(call, token)
 	return
 }
	// This file was auto-generated by the veyron vdl tool.
	// Source: identity.vdl

	// Package identity defines services for identity providers in the veyron ecosystem.
	package identity

	import (
	// The non-user imports are prefixed with "_gen_" to prevent collisions.
	_gen_context "veyron2/context"
	_gen_ipc "veyron2/ipc"
	_gen_naming "veyron2/naming"
	_gen_rt "veyron2/rt"
	_gen_vdlutil "veyron2/vdl/vdlutil"
	_gen_wiretype "veyron2/wiretype"
	)

	// TODO(bprosnitz) Remove this line once signatures are updated to use typevals.
	// It corrects a bug where _gen_wiretype is unused in VDL pacakges where only bootstrap types are used on interfaces.
	const _ = _gen_wiretype.TypeIDInvalid

	// OAuthBlesser exchanges OAuth authorization codes OR access tokens for
	// an email address from an OAuth-based identity provider and uses the email
	// address obtained to bless the client.
	//
	// OAuth is described in RFC 6749 (http://tools.ietf.org/html/rfc6749),
	// though the Google implementation also has informative documentation at
	// https://developers.google.com/accounts/docs/OAuth2
	//
	// WARNING: There is no binding between the channel over which the
	// authorization code or access token was obtained (typically https)
	// and the channel used to make the RPC (a veyron virtual circuit).
	// Thus, if Mallory possesses the authorization code or access token
	// associated with Alice's account, she may be able to obtain a blessing
	// with Alice's name on it.
	//
	// TODO(ashankar,toddw): Once the "OneOf" type becomes available in VDL,
	// then the "any" should be replaced by:
	// OneOf<wire.ChainPublicID, []wire.ChainPublicID>
	// where wire is from:
	// import "veyron2/security/wire"
	// OAuthBlesser is the interface the client binds and uses.
	// OAuthBlesser_ExcludingUniversal is the interface without internal framework-added methods
	// to enable embedding without method collisions. Not to be used directly by clients.
	type OAuthBlesser_ExcludingUniversal interface {
	// BlessUsingAuthorizationCode exchanges the provided authorization code
	// for an access token and then uses that access token to obtain an
	// email address.
	//
	// The redirect URL used to obtain the authorization code must also
	// be provided.
	BlessUsingAuthorizationCode(ctx _gen_context.T, authcode string, redirecturl string, opts ..._gen_ipc.CallOpt) (reply _gen_vdlutil.Any, err error)
	// BlessUsingAccessToken uses the provided access token to obtain the email
	// address and returns a blessing.
	BlessUsingAccessToken(ctx _gen_context.T, token string, opts ..._gen_ipc.CallOpt) (reply _gen_vdlutil.Any, err error)
	}
	type OAuthBlesser interface {
	_gen_ipc.UniversalServiceMethods
	OAuthBlesser_ExcludingUniversal
	}

	// OAuthBlesserService is the interface the server implements.
	type OAuthBlesserService interface {

	// BlessUsingAuthorizationCode exchanges the provided authorization code
	// for an access token and then uses that access token to obtain an
	// email address.
	//
	// The redirect URL used to obtain the authorization code must also
	// be provided.
	BlessUsingAuthorizationCode(context _gen_ipc.ServerContext, authcode string, redirecturl string) (reply _gen_vdlutil.Any, err error)
	// BlessUsingAccessToken uses the provided access token to obtain the email
	// address and returns a blessing.
	BlessUsingAccessToken(context _gen_ipc.ServerContext, token string) (reply _gen_vdlutil.Any, err error)
	}

	// BindOAuthBlesser returns the client stub implementing the OAuthBlesser
	// interface.
	//
	// If no _gen_ipc.Client is specified, the default _gen_ipc.Client in the
	// global Runtime is used.
	func BindOAuthBlesser(name string, opts ..._gen_ipc.BindOpt) (OAuthBlesser, error) {
	var client _gen_ipc.Client
	switch len(opts) {
	case 0:
	client = _gen_rt.R().Client()
	case 1:
	switch o := opts[0].(type) {
	case _gen_ipc.Client:
	client = o
	default:
	return nil, _gen_vdlutil.ErrUnrecognizedOption
	}
	default:
	return nil, _gen_vdlutil.ErrTooManyOptionsToBind
	}
	stub := &clientStubOAuthBlesser{client: client, name: name}

	return stub, nil
	}

	// NewServerOAuthBlesser creates a new server stub.
	//
	// It takes a regular server implementing the OAuthBlesserService
	// interface, and returns a new server stub.
	func NewServerOAuthBlesser(server OAuthBlesserService) interface{} {
	return &ServerStubOAuthBlesser{
	service: server,
	}
	}

	// clientStubOAuthBlesser implements OAuthBlesser.
	type clientStubOAuthBlesser struct {
	client _gen_ipc.Client
	name string
	}

	func (__gen_c *clientStubOAuthBlesser) BlessUsingAuthorizationCode(ctx _gen_context.T, authcode string, redirecturl string, opts ..._gen_ipc.CallOpt) (reply _gen_vdlutil.Any, err error) {
	var call _gen_ipc.Call
	if call, err = __gen_c.client.StartCall(ctx, __gen_c.name, "BlessUsingAuthorizationCode", []interface{}{authcode, redirecturl}, opts...); err != nil {
	return
	}
	if ierr := call.Finish(&reply, &err); ierr != nil {
	err = ierr
	}
	return
	}

	func (__gen_c *clientStubOAuthBlesser) BlessUsingAccessToken(ctx _gen_context.T, token string, opts ..._gen_ipc.CallOpt) (reply _gen_vdlutil.Any, err error) {
	var call _gen_ipc.Call
	if call, err = __gen_c.client.StartCall(ctx, __gen_c.name, "BlessUsingAccessToken", []interface{}{token}, opts...); err != nil {
	return
	}
	if ierr := call.Finish(&reply, &err); ierr != nil {
	err = ierr
	}
	return
	}

	func (__gen_c *clientStubOAuthBlesser) UnresolveStep(ctx _gen_context.T, opts ..._gen_ipc.CallOpt) (reply []string, err error) {
	var call _gen_ipc.Call
	if call, err = __gen_c.client.StartCall(ctx, __gen_c.name, "UnresolveStep", nil, opts...); err != nil {
	return
	}
	if ierr := call.Finish(&reply, &err); ierr != nil {
	err = ierr
	}
	return
	}

	func (__gen_c *clientStubOAuthBlesser) Signature(ctx _gen_context.T, opts ..._gen_ipc.CallOpt) (reply _gen_ipc.ServiceSignature, err error) {
	var call _gen_ipc.Call
	if call, err = __gen_c.client.StartCall(ctx, __gen_c.name, "Signature", nil, opts...); err != nil {
	return
	}
	if ierr := call.Finish(&reply, &err); ierr != nil {
	err = ierr
	}
	return
	}

	func (__gen_c *clientStubOAuthBlesser) GetMethodTags(ctx _gen_context.T, method string, opts ..._gen_ipc.CallOpt) (reply []interface{}, err error) {
	var call _gen_ipc.Call
	if call, err = __gen_c.client.StartCall(ctx, __gen_c.name, "GetMethodTags", []interface{}{method}, opts...); err != nil {
	return
	}
	if ierr := call.Finish(&reply, &err); ierr != nil {
	err = ierr
	}
	return
	}

	// ServerStubOAuthBlesser wraps a server that implements
	// OAuthBlesserService and provides an object that satisfies
	// the requirements of veyron2/ipc.ReflectInvoker.
	type ServerStubOAuthBlesser struct {
	service OAuthBlesserService
	}

	func (__gen_s *ServerStubOAuthBlesser) GetMethodTags(call _gen_ipc.ServerCall, method string) ([]interface{}, error) {
	// TODO(bprosnitz) GetMethodTags() will be replaces with Signature().
	// Note: This exhibits some weird behavior like returning a nil error if the method isn't found.
	// This will change when it is replaced with Signature().
	switch method {
	case "BlessUsingAuthorizationCode":
	return []interface{}{}, nil
	case "BlessUsingAccessToken":
	return []interface{}{}, nil
	default:
	return nil, nil
	}
	}

	func (__gen_s *ServerStubOAuthBlesser) Signature(call _gen_ipc.ServerCall) (_gen_ipc.ServiceSignature, error) {
	result := _gen_ipc.ServiceSignature{Methods: make(map[string]_gen_ipc.MethodSignature)}
	result.Methods["BlessUsingAccessToken"] = _gen_ipc.MethodSignature{
	InArgs: []_gen_ipc.MethodArgument{
	{Name: "token", Type: 3},
	},
	OutArgs: []_gen_ipc.MethodArgument{
	{Name: "blessing", Type: 65},
	{Name: "err", Type: 66},
	},
	}
	result.Methods["BlessUsingAuthorizationCode"] = _gen_ipc.MethodSignature{
	InArgs: []_gen_ipc.MethodArgument{
	{Name: "authcode", Type: 3},
	{Name: "redirecturl", Type: 3},
	},
	OutArgs: []_gen_ipc.MethodArgument{
	{Name: "blessing", Type: 65},
	{Name: "err", Type: 66},
	},
	}

	result.TypeDefs = []_gen_vdlutil.Any{
	_gen_wiretype.NamedPrimitiveType{Type: 0x1, Name: "anydata", Tags: []string(nil)}, _gen_wiretype.NamedPrimitiveType{Type: 0x1, Name: "error", Tags: []string(nil)}}

	return result, nil
	}

	func (__gen_s *ServerStubOAuthBlesser) UnresolveStep(call _gen_ipc.ServerCall) (reply []string, err error) {
	if unresolver, ok := __gen_s.service.(_gen_ipc.Unresolver); ok {
	return unresolver.UnresolveStep(call)
	}
	if call.Server() == nil {
	return
	}
	var published []string
	if published, err = call.Server().Published(); err != nil \|\| published == nil {
	return
	}
	reply = make([]string, len(published))
	for i, p := range published {
	reply[i] = _gen_naming.Join(p, call.Name())
	}
	return
	}

	func (__gen_s *ServerStubOAuthBlesser) BlessUsingAuthorizationCode(call _gen_ipc.ServerCall, authcode string, redirecturl string) (reply _gen_vdlutil.Any, err error) {
	reply, err = __gen_s.service.BlessUsingAuthorizationCode(call, authcode, redirecturl)
	return
	}

	func (__gen_s *ServerStubOAuthBlesser) BlessUsingAccessToken(call _gen_ipc.ServerCall, token string) (reply _gen_vdlutil.Any, err error) {
	reply, err = __gen_s.service.BlessUsingAccessToken(call, token)
	return
	}