GRPC Core
18.0.0
|
#include <grpc/support/port_platform.h>
#include <grpc/grpc.h>
#include <grpc/grpc_security_constants.h>
#include <grpc/status.h>
Go to the source code of this file.
Data Structures | |
struct | grpc_auth_property_iterator |
struct | grpc_auth_property |
value, if not NULL, is guaranteed to be NULL terminated. More... | |
struct | grpc_ssl_pem_key_cert_pair |
Object that holds a private key / certificate chain pair in PEM format. More... | |
struct | verify_peer_options |
Deprecated in favor of grpc_ssl_verify_peer_options. More... | |
struct | grpc_ssl_verify_peer_options |
Object that holds additional peer-verification options on a secure channel. More... | |
struct | grpc_sts_credentials_options |
Options for creating STS Oauth Token Exchange credentials following the IETF draft https://tools.ietf.org/html/draft-ietf-oauth-token-exchange-16. More... | |
struct | grpc_auth_metadata_context |
Context that can be used by metadata credentials plugin in order to create auth related metadata. More... | |
struct | grpc_metadata_credentials_plugin |
grpc_metadata_credentials plugin is an API user provided structure used to create grpc_credentials objects that can be set on a channel (composed) or a call. More... | |
struct | grpc_auth_metadata_processor |
Pluggable server-side metadata processor object. More... | |
struct | grpc_tls_server_authorization_check_arg |
A struct containing all information necessary to schedule/cancel a server authorization check request. More... | |
Macros | |
#define | GRPC_METADATA_CREDENTIALS_PLUGIN_SYNC_MAX 4 |
Maximum number of metadata entries returnable by a credentials plugin via a synchronous return. More... | |
Typedefs | |
typedef struct grpc_auth_context | grpc_auth_context |
— Authentication Context. More... | |
typedef struct grpc_auth_property_iterator | grpc_auth_property_iterator |
typedef struct grpc_auth_property | grpc_auth_property |
value, if not NULL, is guaranteed to be NULL terminated. More... | |
typedef struct grpc_ssl_session_cache | grpc_ssl_session_cache |
— SSL Session Cache. More... | |
typedef struct grpc_call_credentials | grpc_call_credentials |
— grpc_call_credentials object. More... | |
typedef struct grpc_channel_credentials | grpc_channel_credentials |
— grpc_channel_credentials object. More... | |
typedef grpc_ssl_roots_override_result(* | grpc_ssl_roots_override_callback) (char **pem_root_certs) |
Callback for getting the SSL roots override from the application. More... | |
typedef void(* | grpc_credentials_plugin_metadata_cb) (void *user_data, const grpc_metadata *creds_md, size_t num_creds_md, grpc_status_code status, const char *error_details) |
Callback function to be called by the metadata credentials plugin implementation when the metadata is ready. More... | |
typedef struct grpc_server_credentials | grpc_server_credentials |
— grpc_server_credentials object. More... | |
typedef struct grpc_ssl_server_certificate_config | grpc_ssl_server_certificate_config |
Server certificate config object holds the server's public certificates and associated private keys, as well as any CA certificates needed for client certificate validation (if applicable). More... | |
typedef grpc_ssl_certificate_config_reload_status(* | grpc_ssl_server_certificate_config_callback) (void *user_data, grpc_ssl_server_certificate_config **config) |
Callback to retrieve updated SSL server certificates, private keys, and trusted CAs (for client authentication). More... | |
typedef struct grpc_ssl_server_credentials_options | grpc_ssl_server_credentials_options |
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) |
— Auth Metadata Processing — More... | |
typedef struct grpc_alts_credentials_options | grpc_alts_credentials_options |
— ALTS channel/server credentials — More... | |
typedef struct grpc_tls_error_details | grpc_tls_error_details |
— TLS channel/server credentials — It is used for experimental purpose for now and subject to change. More... | |
typedef struct grpc_tls_server_authorization_check_config | grpc_tls_server_authorization_check_config |
Config for TLS server authorization check. More... | |
typedef struct grpc_tls_credentials_options | grpc_tls_credentials_options |
A struct that can be specified by callers to configure underlying TLS behaviors. More... | |
typedef struct grpc_tls_certificate_provider | grpc_tls_certificate_provider |
A struct provides ways to gain credential data that will be used in the TLS handshake. More... | |
typedef struct grpc_tls_identity_pairs | grpc_tls_identity_pairs |
A struct that stores the credential data presented to the peer in handshake to show local identity. More... | |
typedef struct grpc_tls_server_authorization_check_arg | grpc_tls_server_authorization_check_arg |
— TLS server authorization check config. More... | |
typedef void(* | grpc_tls_on_server_authorization_check_done_cb) (grpc_tls_server_authorization_check_arg *arg) |
callback function provided by gRPC used to handle the result of server authorization check. More... | |
typedef struct grpc_authorization_policy_provider | grpc_authorization_policy_provider |
EXPERIMENTAL - Subject to change. More... | |
Functions | |
GRPCAPI const grpc_auth_property * | grpc_auth_property_iterator_next (grpc_auth_property_iterator *it) |
Returns NULL when the iterator is at the end. More... | |
GRPCAPI grpc_auth_property_iterator | grpc_auth_context_property_iterator (const grpc_auth_context *ctx) |
Iterates over the auth context. More... | |
GRPCAPI grpc_auth_property_iterator | grpc_auth_context_peer_identity (const grpc_auth_context *ctx) |
Gets the peer identity. More... | |
GRPCAPI grpc_auth_property_iterator | grpc_auth_context_find_properties_by_name (const grpc_auth_context *ctx, const char *name) |
Finds a property in the context. More... | |
GRPCAPI const char * | grpc_auth_context_peer_identity_property_name (const grpc_auth_context *ctx) |
Gets the name of the property that indicates the peer identity. More... | |
GRPCAPI int | grpc_auth_context_peer_is_authenticated (const grpc_auth_context *ctx) |
Returns 1 if the peer is authenticated, 0 otherwise. More... | |
GRPCAPI grpc_auth_context * | grpc_call_auth_context (grpc_call *call) |
Gets the auth context from the call. More... | |
GRPCAPI void | grpc_auth_context_release (grpc_auth_context *context) |
Releases the auth context returned from grpc_call_auth_context. More... | |
GRPCAPI void | grpc_auth_context_add_property (grpc_auth_context *ctx, const char *name, const char *value, size_t value_length) |
– The following auth context methods should only be called by a server metadata More... | |
GRPCAPI void | grpc_auth_context_add_cstring_property (grpc_auth_context *ctx, const char *name, const char *value) |
Add a C string property. More... | |
GRPCAPI int | grpc_auth_context_set_peer_identity_property_name (grpc_auth_context *ctx, const char *name) |
Sets the property name. More... | |
GRPCAPI grpc_ssl_session_cache * | grpc_ssl_session_cache_create_lru (size_t capacity) |
Create LRU cache for client-side SSL sessions with the given capacity. More... | |
GRPCAPI void | grpc_ssl_session_cache_destroy (grpc_ssl_session_cache *cache) |
Destroy SSL session cache. More... | |
GRPCAPI grpc_arg | grpc_ssl_session_cache_create_channel_arg (grpc_ssl_session_cache *cache) |
Create a channel arg with the given cache object. More... | |
GRPCAPI void | grpc_call_credentials_release (grpc_call_credentials *creds) |
Releases a call credentials object. More... | |
GRPCAPI void | grpc_channel_credentials_release (grpc_channel_credentials *creds) |
Releases a channel credentials object. More... | |
GRPCAPI grpc_channel_credentials * | grpc_google_default_credentials_create (grpc_call_credentials *call_credentials) |
Creates default credentials to connect to a google gRPC service. More... | |
GRPCAPI void | grpc_set_ssl_roots_override_callback (grpc_ssl_roots_override_callback cb) |
Setup a callback to override the default TLS/SSL roots. More... | |
GRPCAPI grpc_channel_credentials * | grpc_ssl_credentials_create (const char *pem_root_certs, grpc_ssl_pem_key_cert_pair *pem_key_cert_pair, const verify_peer_options *verify_options, void *reserved) |
Deprecated in favor of grpc_ssl_server_credentials_create_ex. More... | |
GRPCAPI grpc_channel_credentials * | grpc_ssl_credentials_create_ex (const char *pem_root_certs, grpc_ssl_pem_key_cert_pair *pem_key_cert_pair, const grpc_ssl_verify_peer_options *verify_options, void *reserved) |
GRPCAPI grpc_channel_credentials * | grpc_composite_channel_credentials_create (grpc_channel_credentials *channel_creds, grpc_call_credentials *call_creds, void *reserved) |
Creates a composite channel credentials object. More... | |
GRPCAPI grpc_call_credentials * | grpc_composite_call_credentials_create (grpc_call_credentials *creds1, grpc_call_credentials *creds2, void *reserved) |
— composite credentials. More... | |
GRPCAPI grpc_call_credentials * | grpc_google_compute_engine_credentials_create (void *reserved) |
Creates a compute engine credentials object for connecting to Google. More... | |
GRPCAPI gpr_timespec | grpc_max_auth_token_lifetime (void) |
GRPCAPI grpc_call_credentials * | grpc_service_account_jwt_access_credentials_create (const char *json_key, gpr_timespec token_lifetime, void *reserved) |
Creates a JWT credentials object. More... | |
GRPCAPI grpc_call_credentials * | grpc_external_account_credentials_create (const char *json_string, const char *scopes_string) |
Builds External Account credentials. More... | |
GRPCAPI grpc_call_credentials * | grpc_google_refresh_token_credentials_create (const char *json_refresh_token, void *reserved) |
Creates an Oauth2 Refresh Token credentials object for connecting to Google. More... | |
GRPCAPI grpc_call_credentials * | grpc_access_token_credentials_create (const char *access_token, void *reserved) |
Creates an Oauth2 Access Token credentials with an access token that was acquired by an out of band mechanism. More... | |
GRPCAPI grpc_call_credentials * | grpc_google_iam_credentials_create (const char *authorization_token, const char *authority_selector, void *reserved) |
Creates an IAM credentials object for connecting to Google. More... | |
GRPCAPI grpc_call_credentials * | grpc_sts_credentials_create (const grpc_sts_credentials_options *options, void *reserved) |
Creates an STS credentials following the STS Token Exchanged specifed in the IETF draft https://tools.ietf.org/html/draft-ietf-oauth-token-exchange-16. More... | |
GRPCAPI void | grpc_auth_metadata_context_copy (grpc_auth_metadata_context *from, grpc_auth_metadata_context *to) |
Performs a deep copy from from to to. More... | |
GRPCAPI void | grpc_auth_metadata_context_reset (grpc_auth_metadata_context *context) |
Releases internal resources held by context. More... | |
GRPCAPI grpc_call_credentials * | grpc_metadata_credentials_create_from_plugin (grpc_metadata_credentials_plugin plugin, grpc_security_level min_security_level, void *reserved) |
Creates a credentials object from a plugin with a specified minimum security level. More... | |
GRPCAPI grpc_channel * | grpc_secure_channel_create (grpc_channel_credentials *creds, const char *target, const grpc_channel_args *args, void *reserved) |
— Secure channel creation. More... | |
GRPCAPI void | grpc_server_credentials_release (grpc_server_credentials *creds) |
Releases a server_credentials object. More... | |
GRPCAPI grpc_ssl_server_certificate_config * | grpc_ssl_server_certificate_config_create (const char *pem_root_certs, const grpc_ssl_pem_key_cert_pair *pem_key_cert_pairs, size_t num_key_cert_pairs) |
Creates a grpc_ssl_server_certificate_config object. More... | |
GRPCAPI void | grpc_ssl_server_certificate_config_destroy (grpc_ssl_server_certificate_config *config) |
Destroys a grpc_ssl_server_certificate_config object. More... | |
GRPCAPI 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) |
Deprecated in favor of grpc_ssl_server_credentials_create_ex. More... | |
GRPCAPI grpc_server_credentials * | grpc_ssl_server_credentials_create_ex (const char *pem_root_certs, grpc_ssl_pem_key_cert_pair *pem_key_cert_pairs, size_t num_key_cert_pairs, grpc_ssl_client_certificate_request_type client_certificate_request, void *reserved) |
Deprecated in favor of grpc_ssl_server_credentials_create_with_options. More... | |
GRPCAPI grpc_ssl_server_credentials_options * | grpc_ssl_server_credentials_create_options_using_config (grpc_ssl_client_certificate_request_type client_certificate_request, grpc_ssl_server_certificate_config *certificate_config) |
Creates an options object using a certificate config. More... | |
GRPCAPI grpc_ssl_server_credentials_options * | grpc_ssl_server_credentials_create_options_using_config_fetcher (grpc_ssl_client_certificate_request_type client_certificate_request, grpc_ssl_server_certificate_config_callback cb, void *user_data) |
Creates an options object using a certificate config fetcher. More... | |
GRPCAPI void | grpc_ssl_server_credentials_options_destroy (grpc_ssl_server_credentials_options *options) |
Destroys a grpc_ssl_server_credentials_options object. More... | |
GRPCAPI grpc_server_credentials * | grpc_ssl_server_credentials_create_with_options (grpc_ssl_server_credentials_options *options) |
Creates an SSL server_credentials object using the provided options struct. More... | |
GRPCAPI int | grpc_server_add_secure_http2_port (grpc_server *server, const char *addr, grpc_server_credentials *creds) |
— Server-side secure ports. More... | |
GRPCAPI grpc_call_error | grpc_call_set_credentials (grpc_call *call, grpc_call_credentials *creds) |
— Call specific credentials. More... | |
GRPCAPI void | grpc_server_credentials_set_auth_metadata_processor (grpc_server_credentials *creds, grpc_auth_metadata_processor processor) |
GRPCAPI grpc_alts_credentials_options * | grpc_alts_credentials_client_options_create (void) |
This method creates a grpc ALTS credentials client options instance. More... | |
GRPCAPI grpc_alts_credentials_options * | grpc_alts_credentials_server_options_create (void) |
This method creates a grpc ALTS credentials server options instance. More... | |
GRPCAPI void | grpc_alts_credentials_client_options_add_target_service_account (grpc_alts_credentials_options *options, const char *service_account) |
This method adds a target service account to grpc client's ALTS credentials options instance. More... | |
GRPCAPI void | grpc_alts_credentials_options_destroy (grpc_alts_credentials_options *options) |
This method destroys a grpc_alts_credentials_options instance by de-allocating all of its occupied memory. More... | |
GRPCAPI grpc_channel_credentials * | grpc_alts_credentials_create (const grpc_alts_credentials_options *options) |
This method creates an ALTS channel credential object. More... | |
GRPCAPI grpc_server_credentials * | grpc_alts_server_credentials_create (const grpc_alts_credentials_options *options) |
This method creates an ALTS server credential object. More... | |
GRPCAPI grpc_channel_credentials * | grpc_local_credentials_create (grpc_local_connect_type type) |
— Local channel/server credentials — More... | |
GRPCAPI grpc_server_credentials * | grpc_local_server_credentials_create (grpc_local_connect_type type) |
This method creates a local server credential object. More... | |
GRPCAPI grpc_tls_identity_pairs * | grpc_tls_identity_pairs_create () |
Creates a grpc_tls_identity_pairs that stores a list of identity credential data, including identity private key and identity certificate chain. More... | |
GRPCAPI void | grpc_tls_identity_pairs_add_pair (grpc_tls_identity_pairs *pairs, const char *private_key, const char *cert_chain) |
Adds a identity private key and a identity certificate chain to grpc_tls_identity_pairs. More... | |
GRPCAPI void | grpc_tls_identity_pairs_destroy (grpc_tls_identity_pairs *pairs) |
Destroys a grpc_tls_identity_pairs object. More... | |
GRPCAPI grpc_tls_certificate_provider * | grpc_tls_certificate_provider_static_data_create (const char *root_certificate, grpc_tls_identity_pairs *pem_key_cert_pairs) |
Creates a grpc_tls_certificate_provider that will load credential data from static string during initialization. More... | |
GRPCAPI grpc_tls_certificate_provider * | grpc_tls_certificate_provider_file_watcher_create (const char *private_key_path, const char *identity_certificate_path, const char *root_cert_path, unsigned int refresh_interval_sec) |
Creates a grpc_tls_certificate_provider that will watch the credential changes on the file system. More... | |
GRPCAPI void | grpc_tls_certificate_provider_release (grpc_tls_certificate_provider *provider) |
Releases a grpc_tls_certificate_provider object. More... | |
GRPCAPI grpc_tls_credentials_options * | grpc_tls_credentials_options_create (void) |
Creates an grpc_tls_credentials_options. More... | |
GRPCAPI void | grpc_tls_credentials_options_set_cert_request_type (grpc_tls_credentials_options *options, grpc_ssl_client_certificate_request_type type) |
Sets the options of whether to request and verify client certs. More... | |
GRPCAPI void | grpc_tls_credentials_options_set_server_verification_option (grpc_tls_credentials_options *options, grpc_tls_server_verification_option server_verification_option) |
Sets the options of whether to choose certain checks, e.g. More... | |
GRPCAPI void | grpc_tls_credentials_options_set_certificate_provider (grpc_tls_credentials_options *options, grpc_tls_certificate_provider *provider) |
Sets the credential provider in the options. More... | |
GRPCAPI void | grpc_tls_credentials_options_watch_root_certs (grpc_tls_credentials_options *options) |
If set, gRPC stack will keep watching the root certificates with name |root_cert_name|. More... | |
GRPCAPI void | grpc_tls_credentials_options_set_root_cert_name (grpc_tls_credentials_options *options, const char *root_cert_name) |
Sets the name of the root certificates being watched. More... | |
GRPCAPI void | grpc_tls_credentials_options_watch_identity_key_cert_pairs (grpc_tls_credentials_options *options) |
If set, gRPC stack will keep watching the identity key-cert pairs with name |identity_cert_name|. More... | |
GRPCAPI void | grpc_tls_credentials_options_set_identity_cert_name (grpc_tls_credentials_options *options, const char *identity_cert_name) |
Sets the name of the identity certificates being watched. More... | |
GRPCAPI void | grpc_tls_credentials_options_set_server_authorization_check_config (grpc_tls_credentials_options *options, grpc_tls_server_authorization_check_config *config) |
Sets the configuration for a custom authorization check performed at the end of the handshake. More... | |
GRPCAPI grpc_tls_server_authorization_check_config * | grpc_tls_server_authorization_check_config_create (const void *config_user_data, int(*schedule)(void *config_user_data, grpc_tls_server_authorization_check_arg *arg), void(*cancel)(void *config_user_data, grpc_tls_server_authorization_check_arg *arg), void(*destruct)(void *config_user_data)) |
Create a grpc_tls_server_authorization_check_config instance. More... | |
GRPCAPI void | grpc_tls_server_authorization_check_config_release (grpc_tls_server_authorization_check_config *config) |
Releases a grpc_tls_server_authorization_check_config object. More... | |
grpc_channel_credentials * | grpc_tls_credentials_create (grpc_tls_credentials_options *options) |
Creates a TLS channel credential object based on the grpc_tls_credentials_options specified by callers. More... | |
grpc_server_credentials * | grpc_tls_server_credentials_create (grpc_tls_credentials_options *options) |
Creates a TLS server credential object based on the grpc_tls_credentials_options specified by callers. More... | |
grpc_channel_credentials * | grpc_insecure_credentials_create () |
EXPERIMENTAL API - Subject to change. More... | |
grpc_server_credentials * | grpc_insecure_server_credentials_create () |
EXPERIMENTAL API - Subject to change. More... | |
GRPCAPI grpc_channel_credentials * | grpc_xds_credentials_create (grpc_channel_credentials *fallback_credentials) |
EXPERIMENTAL API - Subject to change. More... | |
GRPCAPI grpc_server_credentials * | grpc_xds_server_credentials_create (grpc_server_credentials *fallback_credentials) |
EXPERIMENTAL API - Subject to change. More... | |
GRPCAPI grpc_authorization_policy_provider * | grpc_authorization_policy_provider_static_data_create (const char *authz_policy, grpc_status_code *code, const char **error_details) |
EXPERIMENTAL - Subject to change. More... | |
GRPCAPI void | grpc_authorization_policy_provider_release (grpc_authorization_policy_provider *provider) |
EXPERIMENTAL - Subject to change. More... | |
#define GRPC_METADATA_CREDENTIALS_PLUGIN_SYNC_MAX 4 |
Maximum number of metadata entries returnable by a credentials plugin via a synchronous return.
typedef struct grpc_alts_credentials_options grpc_alts_credentials_options |
— ALTS channel/server credentials —
Main interface for ALTS credentials options. The options will contain information that will be passed from grpc to TSI layer such as RPC protocol versions. ALTS client (channel) and server credentials will have their own implementation of this interface. The APIs listed in this header are thread-compatible. It is used for experimental purpose for now and subject to change.
typedef struct grpc_auth_context grpc_auth_context |
— Authentication Context.
—
typedef struct grpc_auth_property grpc_auth_property |
value, if not NULL, is guaranteed to be NULL terminated.
typedef struct grpc_auth_property_iterator grpc_auth_property_iterator |
EXPERIMENTAL - Subject to change.
An opaque type that is responsible for providing authorization policies to gRPC.
typedef struct grpc_call_credentials grpc_call_credentials |
— grpc_call_credentials object.
A call credentials object represents a way to authenticate on a particular call. These credentials can be composed with a channel credentials object so that they are sent with every call on this channel.
typedef struct grpc_channel_credentials grpc_channel_credentials |
— grpc_channel_credentials object.
—
A channel credentials object represents a way to authenticate a client on a channel.
typedef void(* grpc_credentials_plugin_metadata_cb) (void *user_data, const grpc_metadata *creds_md, size_t num_creds_md, grpc_status_code status, const char *error_details) |
Callback function to be called by the metadata credentials plugin implementation when the metadata is ready.
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) |
— Auth Metadata Processing —
Callback function that is called when the metadata processing is done.
typedef struct grpc_server_credentials grpc_server_credentials |
— grpc_server_credentials object.
—
A server credentials object represents a way to authenticate a server.
typedef grpc_ssl_roots_override_result(* grpc_ssl_roots_override_callback) (char **pem_root_certs) |
Callback for getting the SSL roots override from the application.
In case of success, *pem_roots_certs must be set to a NULL terminated string containing the list of PEM encoded root certificates. The ownership is passed to the core and freed (laster by the core) with gpr_free. If this function fails and GRPC_DEFAULT_SSL_ROOTS_FILE_PATH environment is set to a valid path, it will override the roots specified this func
Server certificate config object holds the server's public certificates and associated private keys, as well as any CA certificates needed for client certificate validation (if applicable).
Create using grpc_ssl_server_certificate_config_create().
typedef grpc_ssl_certificate_config_reload_status( * grpc_ssl_server_certificate_config_callback) (void *user_data, grpc_ssl_server_certificate_config **config) |
Callback to retrieve updated SSL server certificates, private keys, and trusted CAs (for client authentication).
typedef struct grpc_ssl_session_cache grpc_ssl_session_cache |
— SSL Session Cache.
—
A SSL session cache object represents a way to cache client sessions between connections. Only ticket-based resumption is supported.
typedef struct grpc_tls_certificate_provider grpc_tls_certificate_provider |
A struct provides ways to gain credential data that will be used in the TLS handshake.
It is used for experimental purpose for now and subject to change.
typedef struct grpc_tls_credentials_options grpc_tls_credentials_options |
A struct that can be specified by callers to configure underlying TLS behaviors.
It is used for experimental purpose for now and subject to change.
typedef struct grpc_tls_error_details grpc_tls_error_details |
— TLS channel/server credentials — It is used for experimental purpose for now and subject to change.
Struct for indicating errors. It is used for experimental purpose for now and subject to change.
typedef struct grpc_tls_identity_pairs grpc_tls_identity_pairs |
A struct that stores the credential data presented to the peer in handshake to show local identity.
It is used for experimental purpose for now and subject to change.
typedef void(* grpc_tls_on_server_authorization_check_done_cb) (grpc_tls_server_authorization_check_arg *arg) |
callback function provided by gRPC used to handle the result of server authorization check.
It is used when schedule API is implemented asynchronously, and serves to bring the control back to gRPC C core. It is used for experimental purpose for now and subject to change.
— TLS server authorization check config.
— It is used for experimental purpose for now and subject to change.
typedef struct grpc_tls_server_authorization_check_config grpc_tls_server_authorization_check_config |
Config for TLS server authorization check.
It is used for experimental purpose for now and subject to change.
GRPCAPI grpc_call_credentials* grpc_access_token_credentials_create | ( | const char * | access_token, |
void * | reserved | ||
) |
Creates an Oauth2 Access Token credentials with an access token that was acquired by an out of band mechanism.
GRPCAPI void grpc_alts_credentials_client_options_add_target_service_account | ( | grpc_alts_credentials_options * | options, |
const char * | service_account | ||
) |
This method adds a target service account to grpc client's ALTS credentials options instance.
It is used for experimental purpose for now and subject to change.
GRPCAPI grpc_alts_credentials_options* grpc_alts_credentials_client_options_create | ( | void | ) |
This method creates a grpc ALTS credentials client options instance.
It is used for experimental purpose for now and subject to change.
GRPCAPI grpc_channel_credentials* grpc_alts_credentials_create | ( | const grpc_alts_credentials_options * | options | ) |
This method creates an ALTS channel credential object.
The security level of the resulting connection is GRPC_PRIVACY_AND_INTEGRITY. It is used for experimental purpose for now and subject to change.
It returns the created ALTS channel credential object.
GRPCAPI void grpc_alts_credentials_options_destroy | ( | grpc_alts_credentials_options * | options | ) |
This method destroys a grpc_alts_credentials_options instance by de-allocating all of its occupied memory.
It is used for experimental purpose for now and subject to change.
GRPCAPI grpc_alts_credentials_options* grpc_alts_credentials_server_options_create | ( | void | ) |
This method creates a grpc ALTS credentials server options instance.
It is used for experimental purpose for now and subject to change.
GRPCAPI grpc_server_credentials* grpc_alts_server_credentials_create | ( | const grpc_alts_credentials_options * | options | ) |
This method creates an ALTS server credential object.
It is used for experimental purpose for now and subject to change.
It returns the created ALTS server credential object.
GRPCAPI void grpc_auth_context_add_cstring_property | ( | grpc_auth_context * | ctx, |
const char * | name, | ||
const char * | value | ||
) |
Add a C string property.
GRPCAPI void grpc_auth_context_add_property | ( | grpc_auth_context * | ctx, |
const char * | name, | ||
const char * | value, | ||
size_t | value_length | ||
) |
GRPCAPI grpc_auth_property_iterator grpc_auth_context_find_properties_by_name | ( | const grpc_auth_context * | ctx, |
const char * | name | ||
) |
Finds a property in the context.
May return an empty iterator (first _next will return NULL) if no property with this name was found in the context.
GRPCAPI grpc_auth_property_iterator grpc_auth_context_peer_identity | ( | const grpc_auth_context * | ctx | ) |
Gets the peer identity.
Returns an empty iterator (first _next will return NULL) if the peer is not authenticated.
GRPCAPI const char* grpc_auth_context_peer_identity_property_name | ( | const grpc_auth_context * | ctx | ) |
Gets the name of the property that indicates the peer identity.
Will return NULL if the peer is not authenticated.
GRPCAPI int grpc_auth_context_peer_is_authenticated | ( | const grpc_auth_context * | ctx | ) |
Returns 1 if the peer is authenticated, 0 otherwise.
GRPCAPI grpc_auth_property_iterator grpc_auth_context_property_iterator | ( | const grpc_auth_context * | ctx | ) |
Iterates over the auth context.
GRPCAPI void grpc_auth_context_release | ( | grpc_auth_context * | context | ) |
Releases the auth context returned from grpc_call_auth_context.
GRPCAPI int grpc_auth_context_set_peer_identity_property_name | ( | grpc_auth_context * | ctx, |
const char * | name | ||
) |
Sets the property name.
Returns 1 if successful or 0 in case of failure (which means that no property with this name exists).
GRPCAPI void grpc_auth_metadata_context_copy | ( | grpc_auth_metadata_context * | from, |
grpc_auth_metadata_context * | to | ||
) |
Performs a deep copy from from to to.
GRPCAPI void grpc_auth_metadata_context_reset | ( | grpc_auth_metadata_context * | context | ) |
Releases internal resources held by context.
GRPCAPI const grpc_auth_property* grpc_auth_property_iterator_next | ( | grpc_auth_property_iterator * | it | ) |
Returns NULL when the iterator is at the end.
GRPCAPI void grpc_authorization_policy_provider_release | ( | grpc_authorization_policy_provider * | provider | ) |
EXPERIMENTAL - Subject to change.
Releases grpc_authorization_policy_provider object. The creator of grpc_authorization_policy_provider is responsible for its release.
GRPCAPI grpc_authorization_policy_provider* grpc_authorization_policy_provider_static_data_create | ( | const char * | authz_policy, |
grpc_status_code * | code, | ||
const char ** | error_details | ||
) |
EXPERIMENTAL - Subject to change.
Creates a grpc_authorization_policy_provider using SDK authorization policy from static string.
GRPCAPI grpc_auth_context* grpc_call_auth_context | ( | grpc_call * | call | ) |
Gets the auth context from the call.
Caller needs to call grpc_auth_context_release on the returned context.
GRPCAPI void grpc_call_credentials_release | ( | grpc_call_credentials * | creds | ) |
Releases a call credentials object.
The creator of the credentials object is responsible for its release.
GRPCAPI grpc_call_error grpc_call_set_credentials | ( | grpc_call * | call, |
grpc_call_credentials * | creds | ||
) |
— Call specific credentials.
— Sets a credentials to a call. Can only be called on the client side before grpc_call_start_batch.
GRPCAPI void grpc_channel_credentials_release | ( | grpc_channel_credentials * | creds | ) |
Releases a channel credentials object.
The creator of the credentials object is responsible for its release.
GRPCAPI grpc_call_credentials* grpc_composite_call_credentials_create | ( | grpc_call_credentials * | creds1, |
grpc_call_credentials * | creds2, | ||
void * | reserved | ||
) |
— composite credentials.
Creates a composite call credentials object.
GRPCAPI grpc_channel_credentials* grpc_composite_channel_credentials_create | ( | grpc_channel_credentials * | channel_creds, |
grpc_call_credentials * | call_creds, | ||
void * | reserved | ||
) |
Creates a composite channel credentials object.
The security level of resulting connection is determined by channel_creds.
GRPCAPI grpc_call_credentials* grpc_external_account_credentials_create | ( | const char * | json_string, |
const char * | scopes_string | ||
) |
Builds External Account credentials.
GRPCAPI grpc_call_credentials* grpc_google_compute_engine_credentials_create | ( | void * | reserved | ) |
Creates a compute engine credentials object for connecting to Google.
WARNING: Do NOT use this credentials to connect to a non-google service as this could result in an oauth2 token leak.
GRPCAPI grpc_channel_credentials* grpc_google_default_credentials_create | ( | grpc_call_credentials * | call_credentials | ) |
Creates default credentials to connect to a google gRPC service.
WARNING: Do NOT use this credentials to connect to a non-google service as this could result in an oauth2 token leak. The security level of the resulting connection is GRPC_PRIVACY_AND_INTEGRITY.
If specified, the supplied call credentials object will be attached to the returned channel credentials object. The call_credentials object must remain valid throughout the lifetime of the returned grpc_channel_credentials object. It is expected that the call credentials object was generated according to the Application Default Credentials mechanism and asserts the identity of the default service account of the machine. Supplying any other sort of call credential will result in undefined behavior, up to and including the sudden and unexpected failure of RPCs.
If nullptr is supplied, the returned channel credentials object will use a call credentials object based on the Application Default Credentials mechanism.
GRPCAPI grpc_call_credentials* grpc_google_iam_credentials_create | ( | const char * | authorization_token, |
const char * | authority_selector, | ||
void * | reserved | ||
) |
Creates an IAM credentials object for connecting to Google.
GRPCAPI grpc_call_credentials* grpc_google_refresh_token_credentials_create | ( | const char * | json_refresh_token, |
void * | reserved | ||
) |
Creates an Oauth2 Refresh Token credentials object for connecting to Google.
May return NULL if the input is invalid. WARNING: Do NOT use this credentials to connect to a non-google service as this could result in an oauth2 token leak.
grpc_channel_credentials* grpc_insecure_credentials_create | ( | ) |
EXPERIMENTAL API - Subject to change.
This method creates an insecure channel credentials object.
grpc_server_credentials* grpc_insecure_server_credentials_create | ( | ) |
EXPERIMENTAL API - Subject to change.
This method creates an insecure server credentials object.
GRPCAPI grpc_channel_credentials* grpc_local_credentials_create | ( | grpc_local_connect_type | type | ) |
— Local channel/server credentials —
This method creates a local channel credential object. The security level of the resulting connection is GRPC_PRIVACY_AND_INTEGRITY for UDS and GRPC_SECURITY_NONE for LOCAL_TCP. It is used for experimental purpose for now and subject to change.
It returns the created local channel credential object.
GRPCAPI grpc_server_credentials* grpc_local_server_credentials_create | ( | grpc_local_connect_type | type | ) |
This method creates a local server credential object.
It is used for experimental purpose for now and subject to change.
It returns the created local server credential object.
GRPCAPI gpr_timespec grpc_max_auth_token_lifetime | ( | void | ) |
GRPCAPI grpc_call_credentials* grpc_metadata_credentials_create_from_plugin | ( | grpc_metadata_credentials_plugin | plugin, |
grpc_security_level | min_security_level, | ||
void * | reserved | ||
) |
Creates a credentials object from a plugin with a specified minimum security level.
GRPCAPI grpc_channel* grpc_secure_channel_create | ( | grpc_channel_credentials * | creds, |
const char * | target, | ||
const grpc_channel_args * | args, | ||
void * | reserved | ||
) |
— Secure channel creation.
— Creates a secure channel using the passed-in credentials. Additional channel level configuration MAY be provided by grpc_channel_args, though the expectation is that most clients will want to simply pass NULL. The user data in 'args' need only live through the invocation of this function. However, if any args of the 'pointer' type are passed, then the referenced vtable must be maintained by the caller until grpc_channel_destroy terminates. See grpc_channel_args definition for more on this.
GRPCAPI int grpc_server_add_secure_http2_port | ( | grpc_server * | server, |
const char * | addr, | ||
grpc_server_credentials * | creds | ||
) |
— Server-side secure ports.
— Add a HTTP2 over an encrypted link over tcp listener. Returns bound port number on success, 0 on failure. REQUIRES: server not started
GRPCAPI void grpc_server_credentials_release | ( | grpc_server_credentials * | creds | ) |
Releases a server_credentials object.
The creator of the server_credentials object is responsible for its release.
GRPCAPI void grpc_server_credentials_set_auth_metadata_processor | ( | grpc_server_credentials * | creds, |
grpc_auth_metadata_processor | processor | ||
) |
GRPCAPI grpc_call_credentials* grpc_service_account_jwt_access_credentials_create | ( | const char * | json_key, |
gpr_timespec | token_lifetime, | ||
void * | reserved | ||
) |
Creates a JWT credentials object.
May return NULL if the input is invalid.
GRPCAPI void grpc_set_ssl_roots_override_callback | ( | grpc_ssl_roots_override_callback | cb | ) |
Setup a callback to override the default TLS/SSL roots.
This function is not thread-safe and must be called at initialization time before any ssl credentials are created to have the desired side effect. If GRPC_DEFAULT_SSL_ROOTS_FILE_PATH environment is set to a valid path, the callback will not be called.
GRPCAPI grpc_channel_credentials* grpc_ssl_credentials_create | ( | const char * | pem_root_certs, |
grpc_ssl_pem_key_cert_pair * | pem_key_cert_pair, | ||
const verify_peer_options * | verify_options, | ||
void * | reserved | ||
) |
Deprecated in favor of grpc_ssl_server_credentials_create_ex.
It will be removed after all of its call sites are migrated to grpc_ssl_server_credentials_create_ex. Creates an SSL credentials object. The security level of the resulting connection is GRPC_PRIVACY_AND_INTEGRITY.
pem_root_certs is the NULL-terminated string containing the PEM encoding of the server root certificates. If this parameter is NULL, the implementation will first try to dereference the file pointed by the GRPC_DEFAULT_SSL_ROOTS_FILE_PATH environment variable, and if that fails, try to get the roots set by grpc_override_ssl_default_roots. Eventually, if all these fail, it will try to get the roots from a well-known place on disk (in the grpc install directory).
gRPC has implemented root cache if the underlying OpenSSL library supports it. The gRPC root certificates cache is only applicable on the default root certificates, which is used when this parameter is nullptr. If user provides their own pem_root_certs, when creating an SSL credential object, gRPC would not be able to cache it, and each subchannel will generate a copy of the root store. So it is recommended to avoid providing large room pem with pem_root_certs parameter to avoid excessive memory consumption, particularly on mobile platforms such as iOS.
GRPCAPI grpc_channel_credentials* grpc_ssl_credentials_create_ex | ( | const char * | pem_root_certs, |
grpc_ssl_pem_key_cert_pair * | pem_key_cert_pair, | ||
const grpc_ssl_verify_peer_options * | verify_options, | ||
void * | reserved | ||
) |
GRPCAPI grpc_ssl_server_certificate_config* grpc_ssl_server_certificate_config_create | ( | const char * | pem_root_certs, |
const grpc_ssl_pem_key_cert_pair * | pem_key_cert_pairs, | ||
size_t | num_key_cert_pairs | ||
) |
Creates a grpc_ssl_server_certificate_config object.
GRPCAPI void grpc_ssl_server_certificate_config_destroy | ( | grpc_ssl_server_certificate_config * | config | ) |
Destroys a grpc_ssl_server_certificate_config object.
GRPCAPI 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 | ||
) |
Deprecated in favor of grpc_ssl_server_credentials_create_ex.
Creates an SSL server_credentials object.
GRPCAPI grpc_server_credentials* grpc_ssl_server_credentials_create_ex | ( | const char * | pem_root_certs, |
grpc_ssl_pem_key_cert_pair * | pem_key_cert_pairs, | ||
size_t | num_key_cert_pairs, | ||
grpc_ssl_client_certificate_request_type | client_certificate_request, | ||
void * | reserved | ||
) |
Deprecated in favor of grpc_ssl_server_credentials_create_with_options.
Same as grpc_ssl_server_credentials_create method except uses grpc_ssl_client_certificate_request_type enum to support more ways to authenticate client certificates.
GRPCAPI grpc_ssl_server_credentials_options* grpc_ssl_server_credentials_create_options_using_config | ( | grpc_ssl_client_certificate_request_type | client_certificate_request, |
grpc_ssl_server_certificate_config * | certificate_config | ||
) |
Creates an options object using a certificate config.
Use this method when the certificates and keys of the SSL server will not change during the server's lifetime.
GRPCAPI grpc_ssl_server_credentials_options* grpc_ssl_server_credentials_create_options_using_config_fetcher | ( | grpc_ssl_client_certificate_request_type | client_certificate_request, |
grpc_ssl_server_certificate_config_callback | cb, | ||
void * | user_data | ||
) |
Creates an options object using a certificate config fetcher.
Use this method to reload the certificates and keys of the SSL server without interrupting the operation of the server. Initial certificate config will be fetched during server initialization.
GRPCAPI grpc_server_credentials* grpc_ssl_server_credentials_create_with_options | ( | grpc_ssl_server_credentials_options * | options | ) |
Creates an SSL server_credentials object using the provided options struct.
GRPCAPI void grpc_ssl_server_credentials_options_destroy | ( | grpc_ssl_server_credentials_options * | options | ) |
Destroys a grpc_ssl_server_credentials_options object.
GRPCAPI grpc_arg grpc_ssl_session_cache_create_channel_arg | ( | grpc_ssl_session_cache * | cache | ) |
Create a channel arg with the given cache object.
GRPCAPI grpc_ssl_session_cache* grpc_ssl_session_cache_create_lru | ( | size_t | capacity | ) |
Create LRU cache for client-side SSL sessions with the given capacity.
If capacity is < 1, a default capacity is used instead.
GRPCAPI void grpc_ssl_session_cache_destroy | ( | grpc_ssl_session_cache * | cache | ) |
Destroy SSL session cache.
GRPCAPI grpc_call_credentials* grpc_sts_credentials_create | ( | const grpc_sts_credentials_options * | options, |
void * | reserved | ||
) |
Creates an STS credentials following the STS Token Exchanged specifed in the IETF draft https://tools.ietf.org/html/draft-ietf-oauth-token-exchange-16.
This API is used for experimental purposes for now and may change in the future.
GRPCAPI grpc_tls_certificate_provider* grpc_tls_certificate_provider_file_watcher_create | ( | const char * | private_key_path, |
const char * | identity_certificate_path, | ||
const char * | root_cert_path, | ||
unsigned int | refresh_interval_sec | ||
) |
Creates a grpc_tls_certificate_provider that will watch the credential changes on the file system.
This provider will always return the up-to-date cert data for all the cert names callers set through |grpc_tls_credentials_options|. Note that this API only supports one key-cert file and hence one set of identity key-cert pair, so SNI(Server Name Indication) is not supported.
GRPCAPI void grpc_tls_certificate_provider_release | ( | grpc_tls_certificate_provider * | provider | ) |
Releases a grpc_tls_certificate_provider object.
The creator of the grpc_tls_certificate_provider object is responsible for its release. It is used for experimental purpose for now and subject to change.
GRPCAPI grpc_tls_certificate_provider* grpc_tls_certificate_provider_static_data_create | ( | const char * | root_certificate, |
grpc_tls_identity_pairs * | pem_key_cert_pairs | ||
) |
Creates a grpc_tls_certificate_provider that will load credential data from static string during initialization.
This provider will always return the same cert data for all cert names. root_certificate and pem_key_cert_pairs can be nullptr, indicating the corresponding credential data is not needed. This function will make a copy of |root_certificate|. The ownership of |pem_key_cert_pairs| is transferred. It is used for experimental purpose for now and subject to change.
grpc_channel_credentials* grpc_tls_credentials_create | ( | grpc_tls_credentials_options * | options | ) |
Creates a TLS channel credential object based on the grpc_tls_credentials_options specified by callers.
The grpc_channel_credentials will take the ownership of the |options|. The security level of the resulting connection is GRPC_PRIVACY_AND_INTEGRITY. It is used for experimental purpose for now and subject to change.
GRPCAPI grpc_tls_credentials_options* grpc_tls_credentials_options_create | ( | void | ) |
Creates an grpc_tls_credentials_options.
It is used for experimental purpose for now and subject to change.
GRPCAPI void grpc_tls_credentials_options_set_cert_request_type | ( | grpc_tls_credentials_options * | options, |
grpc_ssl_client_certificate_request_type | type | ||
) |
Sets the options of whether to request and verify client certs.
This should be called only on the server side. It is used for experimental purpose for now and subject to change.
GRPCAPI void grpc_tls_credentials_options_set_certificate_provider | ( | grpc_tls_credentials_options * | options, |
grpc_tls_certificate_provider * | provider | ||
) |
Sets the credential provider in the options.
The |options| will implicitly take a new ref to the |provider|. It is used for experimental purpose for now and subject to change.
GRPCAPI void grpc_tls_credentials_options_set_identity_cert_name | ( | grpc_tls_credentials_options * | options, |
const char * | identity_cert_name | ||
) |
Sets the name of the identity certificates being watched.
If not set, We will use a default empty string as the identity certificate name. It is used for experimental purpose for now and subject to change.
GRPCAPI void grpc_tls_credentials_options_set_root_cert_name | ( | grpc_tls_credentials_options * | options, |
const char * | root_cert_name | ||
) |
Sets the name of the root certificates being watched.
If not set, We will use a default empty string as the root certificate name. It is used for experimental purpose for now and subject to change.
GRPCAPI void grpc_tls_credentials_options_set_server_authorization_check_config | ( | grpc_tls_credentials_options * | options, |
grpc_tls_server_authorization_check_config * | config | ||
) |
Sets the configuration for a custom authorization check performed at the end of the handshake.
The |options| will implicitly take a new ref to the |config|. It is used for experimental purpose for now and subject to change.
GRPCAPI void grpc_tls_credentials_options_set_server_verification_option | ( | grpc_tls_credentials_options * | options, |
grpc_tls_server_verification_option | server_verification_option | ||
) |
Sets the options of whether to choose certain checks, e.g.
certificate check, hostname check, etc. This should be called only on the client side. If |server_verification_option| is not GRPC_TLS_SERVER_VERIFICATION, use of a custom authorization check (grpc_tls_server_authorization_check_config) is mandatory. It is used for experimental purpose for now and subject to change.
GRPCAPI void grpc_tls_credentials_options_watch_identity_key_cert_pairs | ( | grpc_tls_credentials_options * | options | ) |
If set, gRPC stack will keep watching the identity key-cert pairs with name |identity_cert_name|.
This is required on the server side, and optional on the client side. It is used for experimental purpose for now and subject to change.
GRPCAPI void grpc_tls_credentials_options_watch_root_certs | ( | grpc_tls_credentials_options * | options | ) |
If set, gRPC stack will keep watching the root certificates with name |root_cert_name|.
If this is not set on the client side, we will use the root certificates stored in the default system location, since client side must provide root certificates in TLS. If this is not set on the server side, we will not watch any root certificate updates, and assume no root certificates needed for the server(single-side TLS). Default root certs on the server side is not supported. It is used for experimental purpose for now and subject to change.
GRPCAPI void grpc_tls_identity_pairs_add_pair | ( | grpc_tls_identity_pairs * | pairs, |
const char * | private_key, | ||
const char * | cert_chain | ||
) |
Adds a identity private key and a identity certificate chain to grpc_tls_identity_pairs.
This function will make an internal copy of |private_key| and |cert_chain|. It is used for experimental purpose for now and subject to change.
GRPCAPI grpc_tls_identity_pairs* grpc_tls_identity_pairs_create | ( | ) |
Creates a grpc_tls_identity_pairs that stores a list of identity credential data, including identity private key and identity certificate chain.
It is used for experimental purpose for now and subject to change.
GRPCAPI void grpc_tls_identity_pairs_destroy | ( | grpc_tls_identity_pairs * | pairs | ) |
Destroys a grpc_tls_identity_pairs object.
If this object is passed to a provider initiation function, the ownership is transferred so this function doesn't need to be called. Otherwise the creator of the grpc_tls_identity_pairs object is responsible for its destruction. It is used for experimental purpose for now and subject to change.
GRPCAPI grpc_tls_server_authorization_check_config* grpc_tls_server_authorization_check_config_create | ( | const void * | config_user_data, |
int(*)(void *config_user_data, grpc_tls_server_authorization_check_arg *arg) | schedule, | ||
void(*)(void *config_user_data, grpc_tls_server_authorization_check_arg *arg) | cancel, | ||
void(*)(void *config_user_data) | destruct | ||
) |
Create a grpc_tls_server_authorization_check_config instance.
GRPCAPI void grpc_tls_server_authorization_check_config_release | ( | grpc_tls_server_authorization_check_config * | config | ) |
Releases a grpc_tls_server_authorization_check_config object.
The creator of the grpc_tls_server_authorization_check_config object is responsible for its release. It is used for experimental purpose for now and subject to change.
grpc_server_credentials* grpc_tls_server_credentials_create | ( | grpc_tls_credentials_options * | options | ) |
Creates a TLS server credential object based on the grpc_tls_credentials_options specified by callers.
The grpc_server_credentials will take the ownership of the |options|. It is used for experimental purpose for now and subject to change.
GRPCAPI grpc_channel_credentials* grpc_xds_credentials_create | ( | grpc_channel_credentials * | fallback_credentials | ) |
EXPERIMENTAL API - Subject to change.
This method creates an xDS channel credentials object.
Creating a channel with credentials of this type indicates that the channel should get credentials configuration from the xDS control plane.
fallback_credentials are used if the channel target does not have the 'xds:///' scheme or if the xDS control plane does not provide information on how to fetch credentials dynamically. Does NOT take ownership of the fallback_credentials. (Internally takes a ref to the object.)
GRPCAPI grpc_server_credentials* grpc_xds_server_credentials_create | ( | grpc_server_credentials * | fallback_credentials | ) |
EXPERIMENTAL API - Subject to change.
This method creates an xDS server credentials object.
fallback_credentials are used if the xDS control plane does not provide information on how to fetch credentials dynamically.
Does NOT take ownership of the fallback_credentials. (Internally takes a ref to the object.)