credentials.h File Reference

#include <grpc/support/port_platform.h>
#include <string.h>
#include <string>
#include <grpc/grpc.h>
#include <grpc/grpc_security.h>
#include <grpc/support/sync.h>
#include "src/core/lib/transport/metadata_batch.h"
#include "src/core/lib/gprpp/ref_counted.h"
#include "src/core/lib/http/httpcli.h"
#include "src/core/lib/http/parser.h"
#include "src/core/lib/iomgr/polling_entity.h"
#include "src/core/lib/security/security_connector/security_connector.h"

Go to the source code of this file.

Data Structures
struct	grpc_channel_credentials
struct	grpc_credentials_mdelem_array
struct	grpc_call_credentials
struct	grpc_server_credentials
struct	grpc_credentials_metadata_request

Macros
#define	GRPC_FAKE_TRANSPORT_SECURITY_TYPE   "fake"
#define	GRPC_CHANNEL_CREDENTIALS_TYPE_SSL   "Ssl"
#define	GRPC_CHANNEL_CREDENTIALS_TYPE_FAKE_TRANSPORT_SECURITY    "FakeTransportSecurity"
#define	GRPC_CHANNEL_CREDENTIALS_TYPE_GOOGLE_DEFAULT   "GoogleDefault"
#define	GRPC_CALL_CREDENTIALS_TYPE_OAUTH2   "Oauth2"
#define	GRPC_CALL_CREDENTIALS_TYPE_JWT   "Jwt"
#define	GRPC_CALL_CREDENTIALS_TYPE_IAM   "Iam"
#define	GRPC_CALL_CREDENTIALS_TYPE_COMPOSITE   "Composite"
#define	GRPC_AUTHORIZATION_METADATA_KEY   "authorization"
#define	GRPC_IAM_AUTHORIZATION_TOKEN_METADATA_KEY    "x-goog-iam-authorization-token"
#define	GRPC_IAM_AUTHORITY_SELECTOR_METADATA_KEY   "x-goog-iam-authority-selector"
#define	GRPC_SECURE_TOKEN_REFRESH_THRESHOLD_SECS   60
#define	GRPC_COMPUTE_ENGINE_METADATA_HOST   "metadata.google.internal."
#define	GRPC_COMPUTE_ENGINE_METADATA_TOKEN_PATH    "/computeMetadata/v1/instance/service-accounts/default/token"
#define	GRPC_GOOGLE_OAUTH2_SERVICE_HOST   "oauth2.googleapis.com"
#define	GRPC_GOOGLE_OAUTH2_SERVICE_TOKEN_PATH   "/token"
#define	GRPC_SERVICE_ACCOUNT_POST_BODY_PREFIX
#define	GRPC_REFRESH_TOKEN_POST_BODY_FORMAT_STRING    "client_id=%s&client_secret=%s&refresh_token=%s&grant_type=refresh_token"
#define	GRPC_ARG_CHANNEL_CREDENTIALS   "grpc.channel_credentials"
#define	GRPC_SERVER_CREDENTIALS_ARG   "grpc.server_credentials"

Typedefs
typedef std::string(*	grpc_well_known_credentials_path_getter) (void)

Enumerations
enum	grpc_credentials_status { GRPC_CREDENTIALS_OK = 0 , GRPC_CREDENTIALS_ERROR }

Functions
std::string	grpc_get_well_known_google_credentials_file_path (void)
std::string	grpc_get_well_known_google_credentials_file_path_impl (void)
void	grpc_override_well_known_credentials_path_getter (grpc_well_known_credentials_path_getter getter)
grpc_arg	grpc_channel_credentials_to_arg (grpc_channel_credentials *credentials)
grpc_channel_credentials *	grpc_channel_credentials_from_arg (const grpc_arg *arg)
grpc_channel_credentials *	grpc_channel_credentials_find_in_args (const grpc_channel_args *args)
void	grpc_credentials_mdelem_array_add (grpc_credentials_mdelem_array *list, grpc_mdelem md)
	Takes a new ref to md. More...
void	grpc_credentials_mdelem_array_append (grpc_credentials_mdelem_array *dst, grpc_credentials_mdelem_array *src)
	Appends all elements from src to dst, taking a new ref to each one. More...
void	grpc_credentials_mdelem_array_destroy (grpc_credentials_mdelem_array *list)
grpc_call_credentials *	grpc_md_only_test_credentials_create (const char *md_key, const char *md_value, bool is_async)
grpc_arg	grpc_server_credentials_to_arg (grpc_server_credentials *c)
grpc_server_credentials *	grpc_server_credentials_from_arg (const grpc_arg *arg)
grpc_server_credentials *	grpc_find_server_credentials_in_args (const grpc_channel_args *args)
grpc_credentials_metadata_request *	grpc_credentials_metadata_request_create (grpc_core::RefCountedPtr< grpc_call_credentials > creds)
void	grpc_credentials_metadata_request_destroy (grpc_credentials_metadata_request *r)

Macro Definition Documentation

GRPC_ARG_CHANNEL_CREDENTIALS

#define GRPC_ARG_CHANNEL_CREDENTIALS   "grpc.channel_credentials"

GRPC_AUTHORIZATION_METADATA_KEY

#define GRPC_AUTHORIZATION_METADATA_KEY   "authorization"

GRPC_CALL_CREDENTIALS_TYPE_COMPOSITE

#define GRPC_CALL_CREDENTIALS_TYPE_COMPOSITE   "Composite"

GRPC_CALL_CREDENTIALS_TYPE_IAM

#define GRPC_CALL_CREDENTIALS_TYPE_IAM   "Iam"

GRPC_CALL_CREDENTIALS_TYPE_JWT

#define GRPC_CALL_CREDENTIALS_TYPE_JWT   "Jwt"

GRPC_CALL_CREDENTIALS_TYPE_OAUTH2

#define GRPC_CALL_CREDENTIALS_TYPE_OAUTH2   "Oauth2"

GRPC_CHANNEL_CREDENTIALS_TYPE_FAKE_TRANSPORT_SECURITY

#define GRPC_CHANNEL_CREDENTIALS_TYPE_FAKE_TRANSPORT_SECURITY    "FakeTransportSecurity"

GRPC_CHANNEL_CREDENTIALS_TYPE_GOOGLE_DEFAULT

#define GRPC_CHANNEL_CREDENTIALS_TYPE_GOOGLE_DEFAULT   "GoogleDefault"

GRPC_CHANNEL_CREDENTIALS_TYPE_SSL

#define GRPC_CHANNEL_CREDENTIALS_TYPE_SSL   "Ssl"

GRPC_COMPUTE_ENGINE_METADATA_HOST

#define GRPC_COMPUTE_ENGINE_METADATA_HOST   "metadata.google.internal."

GRPC_COMPUTE_ENGINE_METADATA_TOKEN_PATH

#define GRPC_COMPUTE_ENGINE_METADATA_TOKEN_PATH    "/computeMetadata/v1/instance/service-accounts/default/token"

GRPC_FAKE_TRANSPORT_SECURITY_TYPE

#define GRPC_FAKE_TRANSPORT_SECURITY_TYPE   "fake"

GRPC_GOOGLE_OAUTH2_SERVICE_HOST

#define GRPC_GOOGLE_OAUTH2_SERVICE_HOST   "oauth2.googleapis.com"

GRPC_GOOGLE_OAUTH2_SERVICE_TOKEN_PATH

#define GRPC_GOOGLE_OAUTH2_SERVICE_TOKEN_PATH   "/token"

GRPC_IAM_AUTHORITY_SELECTOR_METADATA_KEY

#define GRPC_IAM_AUTHORITY_SELECTOR_METADATA_KEY   "x-goog-iam-authority-selector"

GRPC_IAM_AUTHORIZATION_TOKEN_METADATA_KEY

#define GRPC_IAM_AUTHORIZATION_TOKEN_METADATA_KEY    "x-goog-iam-authorization-token"

GRPC_REFRESH_TOKEN_POST_BODY_FORMAT_STRING

#define GRPC_REFRESH_TOKEN_POST_BODY_FORMAT_STRING    "client_id=%s&client_secret=%s&refresh_token=%s&grant_type=refresh_token"

GRPC_SECURE_TOKEN_REFRESH_THRESHOLD_SECS

#define GRPC_SECURE_TOKEN_REFRESH_THRESHOLD_SECS   60

GRPC_SERVER_CREDENTIALS_ARG

#define GRPC_SERVER_CREDENTIALS_ARG   "grpc.server_credentials"

GRPC_SERVICE_ACCOUNT_POST_BODY_PREFIX

#define GRPC_SERVICE_ACCOUNT_POST_BODY_PREFIX

Value:

  "grant_type=urn%3Aietf%3Aparams%3Aoauth%3Agrant-type%3Ajwt-bearer&" \
  "assertion="

Typedef Documentation

grpc_well_known_credentials_path_getter

typedef std::string(* grpc_well_known_credentials_path_getter) (void)

Enumeration Type Documentation

grpc_credentials_status

enum grpc_credentials_status

Enumerator
GRPC_CREDENTIALS_OK
GRPC_CREDENTIALS_ERROR

Function Documentation

grpc_channel_credentials_find_in_args()

grpc_channel_credentials* grpc_channel_credentials_find_in_args

(

const grpc_channel_args *

args

)

grpc_channel_credentials_from_arg()

grpc_channel_credentials* grpc_channel_credentials_from_arg

(

const grpc_arg *

arg

)

grpc_channel_credentials_to_arg()

grpc_arg grpc_channel_credentials_to_arg

(

grpc_channel_credentials *

credentials

)

grpc_credentials_mdelem_array_add()

void grpc_credentials_mdelem_array_add	(	grpc_credentials_mdelem_array *	list,
		grpc_mdelem	md
	)

Takes a new ref to md.

grpc_credentials_mdelem_array_append()

void grpc_credentials_mdelem_array_append	(	grpc_credentials_mdelem_array *	dst,
		grpc_credentials_mdelem_array *	src
	)

Appends all elements from src to dst, taking a new ref to each one.

grpc_credentials_mdelem_array_destroy()

void grpc_credentials_mdelem_array_destroy

(

grpc_credentials_mdelem_array *

list

)

grpc_credentials_metadata_request_create()

grpc_credentials_metadata_request* grpc_credentials_metadata_request_create ( grpc_core::RefCountedPtr< grpc_call_credentials >  creds )

inline

grpc_credentials_metadata_request_destroy()

void grpc_credentials_metadata_request_destroy ( grpc_credentials_metadata_request *  r )

inline

grpc_find_server_credentials_in_args()

grpc_server_credentials* grpc_find_server_credentials_in_args

(

const grpc_channel_args *

args

)

grpc_get_well_known_google_credentials_file_path()

std::string grpc_get_well_known_google_credentials_file_path

(

void

)

grpc_get_well_known_google_credentials_file_path_impl()

std::string grpc_get_well_known_google_credentials_file_path_impl

(

void

)

grpc_md_only_test_credentials_create()

grpc_call_credentials* grpc_md_only_test_credentials_create	(	const char *	md_key,
		const char *	md_value,
		bool	is_async
	)

grpc_override_well_known_credentials_path_getter()

void grpc_override_well_known_credentials_path_getter

(

grpc_well_known_credentials_path_getter

getter

)

grpc_server_credentials_from_arg()

grpc_server_credentials* grpc_server_credentials_from_arg

(

const grpc_arg *

arg

)

grpc_server_credentials_to_arg()

grpc_arg grpc_server_credentials_to_arg

(

grpc_server_credentials *

c

)