GRPC C++  0.11.0.0
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Member Functions | Static Public Member Functions
grpc::AuthContext Class Referenceabstract

Class encapsulating the Authentication Information. More...

#include <auth_context.h>

Public Member Functions

virtual ~AuthContext ()
 
virtual bool IsPeerAuthenticated () const =0
 Returns true if the peer is authenticated. More...
 
virtual std::vector
< grpc::string_ref
GetPeerIdentity () const =0
 A peer identity. More...
 
virtual grpc::string GetPeerIdentityPropertyName () const =0
 
virtual std::vector
< grpc::string_ref
FindPropertyValues (const grpc::string &name) const =0
 Returns all the property values with the given name. More...
 
virtual AuthPropertyIterator begin () const =0
 Iteration over all the properties. More...
 
virtual AuthPropertyIterator end () const =0
 
virtual void AddProperty (const grpc::string &key, const grpc::string_ref &value)=0
 
virtual bool SetPeerIdentityPropertyName (const grpc::string &name)=0
 

Static Public Member Functions

static string transport_security_type_property_name ()
 
static string ssl_transport_security_type ()
 
static string x509_cn_property_name ()
 
static string x509_san_property_name ()
 

Detailed Description

Class encapsulating the Authentication Information.

It includes the secure identity of the peer, the type of secure transport used as well as any other properties required by the authorization layer.

Constructor & Destructor Documentation

virtual grpc::AuthContext::~AuthContext ( )
inlinevirtual

Member Function Documentation

virtual void grpc::AuthContext::AddProperty ( const grpc::string key,
const grpc::string_ref value 
)
pure virtual
virtual AuthPropertyIterator grpc::AuthContext::begin ( ) const
pure virtual

Iteration over all the properties.

virtual AuthPropertyIterator grpc::AuthContext::end ( ) const
pure virtual
virtual std::vector<grpc::string_ref> grpc::AuthContext::FindPropertyValues ( const grpc::string name) const
pure virtual

Returns all the property values with the given name.

virtual std::vector<grpc::string_ref> grpc::AuthContext::GetPeerIdentity ( ) const
pure virtual

A peer identity.

It is, in general, comprised of one or more properties (in which case they have the same name).

virtual grpc::string grpc::AuthContext::GetPeerIdentityPropertyName ( ) const
pure virtual
virtual bool grpc::AuthContext::IsPeerAuthenticated ( ) const
pure virtual

Returns true if the peer is authenticated.

virtual bool grpc::AuthContext::SetPeerIdentityPropertyName ( const grpc::string name)
pure virtual
static string grpc::AuthContext::ssl_transport_security_type ( )
inlinestatic
static string grpc::AuthContext::transport_security_type_property_name ( )
inlinestatic
static string grpc::AuthContext::x509_cn_property_name ( )
inlinestatic
static string grpc::AuthContext::x509_san_property_name ( )
inlinestatic

The documentation for this class was generated from the following file: