grpc_security.h File Reference

#include <grpc/grpc.h>
#include <grpc/status.h>

Go to the source code of this file.

Data Structures
struct	grpc_ssl_pem_key_cert_pair
struct	grpc_auth_property_iterator
struct	grpc_auth_property
struct	grpc_auth_metadata_processor

Macros
#define	GRPC_GOOGLE_CREDENTIALS_ENV_VAR   "GOOGLE_APPLICATION_CREDENTIALS"
#define	GRPC_DEFAULT_SSL_ROOTS_FILE_PATH_ENV_VAR   "GRPC_DEFAULT_SSL_ROOTS_FILE_PATH"
#define	GRPC_TRANSPORT_SECURITY_TYPE_PROPERTY_NAME   "transport_security_type"
#define	GRPC_SSL_TRANSPORT_SECURITY_TYPE   "ssl"
#define	GRPC_X509_CN_PROPERTY_NAME   "x509_common_name"
#define	GRPC_X509_SAN_PROPERTY_NAME   "x509_subject_alternative_name"

Typedefs
typedef struct grpc_credentials	grpc_credentials
typedef struct grpc_server_credentials	grpc_server_credentials
typedef struct grpc_auth_context	grpc_auth_context
typedef struct grpc_auth_property_iterator	grpc_auth_property_iterator
typedef struct grpc_auth_property	grpc_auth_property
typedef void(*	grpc_process_auth_metadata_done_cb )(void *user_data, const grpc_metadata *consumed_md, size_t num_consumed_md, const grpc_metadata *response_md, size_t num_response_md, grpc_status_code status, const char *error_details)

Functions
void	grpc_credentials_release (grpc_credentials *creds)
grpc_credentials *	grpc_google_default_credentials_create (void)
grpc_credentials *	grpc_ssl_credentials_create (const char *pem_root_certs, grpc_ssl_pem_key_cert_pair *pem_key_cert_pair, void *reserved)
grpc_credentials *	grpc_composite_credentials_create (grpc_credentials *creds1, grpc_credentials *creds2, void *reserved)
grpc_credentials *	grpc_google_compute_engine_credentials_create (void *reserved)
grpc_credentials *	grpc_service_account_jwt_access_credentials_create (const char *json_key, gpr_timespec token_lifetime, void *reserved)
grpc_credentials *	grpc_google_refresh_token_credentials_create (const char *json_refresh_token, void *reserved)
grpc_credentials *	grpc_access_token_credentials_create (const char *access_token, void *reserved)
grpc_credentials *	grpc_google_iam_credentials_create (const char *authorization_token, const char *authority_selector, void *reserved)
grpc_channel *	grpc_secure_channel_create (grpc_credentials *creds, const char *target, const grpc_channel_args *args, void *reserved)
void	grpc_server_credentials_release (grpc_server_credentials *creds)
grpc_server_credentials *	grpc_ssl_server_credentials_create (const char *pem_root_certs, grpc_ssl_pem_key_cert_pair *pem_key_cert_pairs, size_t num_key_cert_pairs, int force_client_auth, void *reserved)
int	grpc_server_add_secure_http2_port (grpc_server *server, const char *addr, grpc_server_credentials *creds)
grpc_call_error	grpc_call_set_credentials (grpc_call *call, grpc_credentials *creds)
const grpc_auth_property *	grpc_auth_property_iterator_next (grpc_auth_property_iterator *it)
grpc_auth_property_iterator	grpc_auth_context_property_iterator (const grpc_auth_context *ctx)
grpc_auth_property_iterator	grpc_auth_context_peer_identity (const grpc_auth_context *ctx)
grpc_auth_property_iterator	grpc_auth_context_find_properties_by_name (const grpc_auth_context *ctx, const char *name)
const char *	grpc_auth_context_peer_identity_property_name (const grpc_auth_context *ctx)
int	grpc_auth_context_peer_is_authenticated (const grpc_auth_context *ctx)
grpc_auth_context *	grpc_call_auth_context (grpc_call *call)
void	grpc_auth_context_release (grpc_auth_context *context)
void	grpc_auth_context_add_property (grpc_auth_context *ctx, const char *name, const char *value, size_t value_length)
void	grpc_auth_context_add_cstring_property (grpc_auth_context *ctx, const char *name, const char *value)
int	grpc_auth_context_set_peer_identity_property_name (grpc_auth_context *ctx, const char *name)
void	grpc_server_credentials_set_auth_metadata_processor (grpc_server_credentials *creds, grpc_auth_metadata_processor processor)

Variables
const gpr_timespec	grpc_max_auth_token_lifetime

Macro Definition Documentation

#define GRPC_DEFAULT_SSL_ROOTS_FILE_PATH_ENV_VAR   "GRPC_DEFAULT_SSL_ROOTS_FILE_PATH"

#define GRPC_GOOGLE_CREDENTIALS_ENV_VAR   "GOOGLE_APPLICATION_CREDENTIALS"

#define GRPC_SSL_TRANSPORT_SECURITY_TYPE   "ssl"

#define GRPC_TRANSPORT_SECURITY_TYPE_PROPERTY_NAME   "transport_security_type"

#define GRPC_X509_CN_PROPERTY_NAME   "x509_common_name"

#define GRPC_X509_SAN_PROPERTY_NAME   "x509_subject_alternative_name"

Typedef Documentation

typedef struct grpc_auth_context grpc_auth_context

typedef struct grpc_auth_property grpc_auth_property

typedef struct grpc_auth_property_iterator grpc_auth_property_iterator

typedef struct grpc_credentials grpc_credentials

typedef void(* grpc_process_auth_metadata_done_cb)(void *user_data, const grpc_metadata *consumed_md, size_t num_consumed_md, const grpc_metadata *response_md, size_t num_response_md, grpc_status_code status, const char *error_details)

typedef struct grpc_server_credentials grpc_server_credentials

Function Documentation

grpc_credentials* grpc_access_token_credentials_create	(	const char *	access_token,
		void *	reserved
	)

void grpc_auth_context_add_cstring_property	(	grpc_auth_context *	ctx,
		const char *	name,
		const char *	value
	)

void grpc_auth_context_add_property	(	grpc_auth_context *	ctx,
		const char *	name,
		const char *	value,
		size_t	value_length
	)

grpc_auth_property_iterator grpc_auth_context_find_properties_by_name	(	const grpc_auth_context *	ctx,
		const char *	name
	)

grpc_auth_property_iterator grpc_auth_context_peer_identity

(

const grpc_auth_context *

ctx

)

const char* grpc_auth_context_peer_identity_property_name

(

const grpc_auth_context *

ctx

)

int grpc_auth_context_peer_is_authenticated

(

const grpc_auth_context *

ctx

)

grpc_auth_property_iterator grpc_auth_context_property_iterator

(

const grpc_auth_context *

ctx

)

void grpc_auth_context_release

(

grpc_auth_context *

context

)

int grpc_auth_context_set_peer_identity_property_name	(	grpc_auth_context *	ctx,
		const char *	name
	)

const grpc_auth_property* grpc_auth_property_iterator_next

(

grpc_auth_property_iterator *

it

)

grpc_auth_context* grpc_call_auth_context

(

grpc_call *

call

)

grpc_call_error grpc_call_set_credentials	(	grpc_call *	call,
		grpc_credentials *	creds
	)

grpc_credentials* grpc_composite_credentials_create	(	grpc_credentials *	creds1,
		grpc_credentials *	creds2,
		void *	reserved
	)

void grpc_credentials_release

(

grpc_credentials *

creds

)

grpc_credentials* grpc_google_compute_engine_credentials_create

(

void *

reserved

)

grpc_credentials* grpc_google_default_credentials_create

(

void

)

grpc_credentials* grpc_google_iam_credentials_create	(	const char *	authorization_token,
		const char *	authority_selector,
		void *	reserved
	)

grpc_credentials* grpc_google_refresh_token_credentials_create	(	const char *	json_refresh_token,
		void *	reserved
	)

grpc_channel* grpc_secure_channel_create	(	grpc_credentials *	creds,
		const char *	target,
		const grpc_channel_args *	args,
		void *	reserved
	)

int grpc_server_add_secure_http2_port	(	grpc_server *	server,
		const char *	addr,
		grpc_server_credentials *	creds
	)

void grpc_server_credentials_release

(

grpc_server_credentials *

creds

)

void grpc_server_credentials_set_auth_metadata_processor	(	grpc_server_credentials *	creds,
		grpc_auth_metadata_processor	processor
	)

grpc_credentials* grpc_service_account_jwt_access_credentials_create	(	const char *	json_key,
		gpr_timespec	token_lifetime,
		void *	reserved
	)

grpc_credentials* grpc_ssl_credentials_create	(	const char *	pem_root_certs,
		grpc_ssl_pem_key_cert_pair *	pem_key_cert_pair,
		void *	reserved
	)

grpc_server_credentials* grpc_ssl_server_credentials_create	(	const char *	pem_root_certs,
		grpc_ssl_pem_key_cert_pair *	pem_key_cert_pairs,
		size_t	num_key_cert_pairs,
		int	force_client_auth,
		void *	reserved
	)

Variable Documentation

const gpr_timespec grpc_max_auth_token_lifetime