GRPC Core 0.10.0.0

- Main Page
- Data Structures
- Files

- File List
- Globals

All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
json_token.h
Go to the documentation of this file.
1 /*
2 *
3 * Copyright 2015, Google Inc.
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are
8 * met:
9 *
10 * * Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * * Redistributions in binary form must reproduce the above
13 * copyright notice, this list of conditions and the following disclaimer
14 * in the documentation and/or other materials provided with the
15 * distribution.
16 * * Neither the name of Google Inc. nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 *
32 */
33
34 #ifndef GRPC_INTERNAL_CORE_SECURITY_JSON_TOKEN_H
35 #define GRPC_INTERNAL_CORE_SECURITY_JSON_TOKEN_H
36
37 #include <grpc/support/slice.h>
38 #include <openssl/rsa.h>
39
40 #include "src/core/json/json.h"
41
42 /* --- Constants. --- */
43
44 #define GRPC_JWT_OAUTH2_AUDIENCE "https://www.googleapis.com/oauth2/v3/token"
45
46 #define GRPC_AUTH_JSON_TYPE_INVALID "invalid"
47 #define GRPC_AUTH_JSON_TYPE_SERVICE_ACCOUNT "service_account"
48 #define GRPC_AUTH_JSON_TYPE_AUTHORIZED_USER "authorized_user"
49
50 /* --- auth_json_key parsing. --- */
51
52 typedef struct {
53 const char *type;
54 char *private_key_id;
55 char *client_id;
56 char *client_email;
57 RSA *private_key;
58 } grpc_auth_json_key;
59
60 /* Returns 1 if the object is valid, 0 otherwise. */
61 int grpc_auth_json_key_is_valid(const grpc_auth_json_key *json_key);
62
63 /* Creates a json_key object from string. Returns an invalid object if a parsing
64 error has been encountered. */
65 grpc_auth_json_key grpc_auth_json_key_create_from_string(
66 const char *json_string);
67
68 /* Creates a json_key object from parsed json. Returns an invalid object if a
69 parsing error has been encountered. */
70 grpc_auth_json_key grpc_auth_json_key_create_from_json(const grpc_json *json);
71
72 /* Destructs the object. */
73 void grpc_auth_json_key_destruct(grpc_auth_json_key *json_key);
74
75 /* --- json token encoding and signing. --- */
76
77 /* Caller is responsible for calling gpr_free on the returned value. May return
78 NULL on invalid input. The scope parameter may be NULL. */
79 char *grpc_jwt_encode_and_sign(const grpc_auth_json_key *json_key,
80 const char *audience,
81 gpr_timespec token_lifetime, const char *scope);
82
83 /* Override encode_and_sign function for testing. */
84 typedef char *(*grpc_jwt_encode_and_sign_override)(
85 const grpc_auth_json_key *json_key, const char *audience,
86 gpr_timespec token_lifetime, const char *scope);
87
88 /* Set a custom encode_and_sign override for testing. */
89 void grpc_jwt_encode_and_sign_set_override(
90 grpc_jwt_encode_and_sign_override func);
91
92 /* --- auth_refresh_token parsing. --- */
93
94 typedef struct {
95 const char *type;
96 char *client_id;
97 char *client_secret;
98 char *refresh_token;
99 } grpc_auth_refresh_token;
100
101 /* Returns 1 if the object is valid, 0 otherwise. */
102 int grpc_auth_refresh_token_is_valid(
103 const grpc_auth_refresh_token *refresh_token);
104
105 /* Creates a refresh token object from string. Returns an invalid object if a
106 parsing error has been encountered. */
107 grpc_auth_refresh_token grpc_auth_refresh_token_create_from_string(
108 const char *json_string);
109
110 /* Creates a refresh token object from parsed json. Returns an invalid object if
111 a parsing error has been encountered. */
112 grpc_auth_refresh_token grpc_auth_refresh_token_create_from_json(
113 const grpc_json *json);
114
115 /* Destructs the object. */
116 void grpc_auth_refresh_token_destruct(grpc_auth_refresh_token *refresh_token);
117
118 #endif /* GRPC_INTERNAL_CORE_SECURITY_JSON_TOKEN_H */
grpc_auth_refresh_token_create_from_json
grpc_auth_refresh_token grpc_auth_refresh_token_create_from_json(const grpc_json *json)
Definition: json_token.c:345
grpc_auth_refresh_token_create_from_string
grpc_auth_refresh_token grpc_auth_refresh_token_create_from_string(const char *json_string)
Definition: json_token.c:379
grpc_auth_json_key_is_valid
int grpc_auth_json_key_is_valid(const grpc_auth_json_key *json_key)
Definition: json_token.c:85
grpc_auth_refresh_token_destruct
void grpc_auth_refresh_token_destruct(grpc_auth_refresh_token *refresh_token)
Definition: json_token.c:390
grpc_auth_refresh_token::type
const char * type
Definition: json_token.h:95
grpc_auth_json_key_create_from_string
grpc_auth_json_key grpc_auth_json_key_create_from_string(const char *json_string)
Definition: json_token.c:141
grpc_auth_json_key::type
const char * type
Definition: json_token.h:53
grpc_auth_refresh_token::refresh_token
char * refresh_token
Definition: json_token.h:98
grpc_auth_json_key::private_key_id
char * private_key_id
Definition: json_token.h:54
grpc_jwt_encode_and_sign_set_override
void grpc_jwt_encode_and_sign_set_override(grpc_jwt_encode_and_sign_override func)
Definition: json_token.c:332
grpc_auth_json_key_destruct
void grpc_auth_json_key_destruct(grpc_auth_json_key *json_key)
Definition: json_token.c:151
grpc_auth_json_key::client_email
char * client_email
Definition: json_token.h:56
grpc_auth_refresh_token::client_id
char * client_id
Definition: json_token.h:96
json.h
grpc_auth_json_key::client_id
char * client_id
Definition: json_token.h:55
grpc_auth_refresh_token
Definition: json_token.h:94
grpc_jwt_encode_and_sign_override
char *(* grpc_jwt_encode_and_sign_override)(const grpc_auth_json_key *json_key, const char *audience, gpr_timespec token_lifetime, const char *scope)
Definition: json_token.h:84
grpc_auth_json_key
Definition: json_token.h:52
grpc_json
Definition: json.h:44
slice.h
grpc_auth_json_key::private_key
RSA * private_key
Definition: json_token.h:57
gpr_timespec
Definition: time.h:60
grpc_auth_refresh_token_is_valid
int grpc_auth_refresh_token_is_valid(const grpc_auth_refresh_token *refresh_token)
Definition: json_token.c:339
grpc_auth_refresh_token::client_secret
char * client_secret
Definition: json_token.h:97
grpc_auth_json_key_create_from_json
grpc_auth_json_key grpc_auth_json_key_create_from_json(const grpc_json *json)
Definition: json_token.c:90
grpc_jwt_encode_and_sign
char * grpc_jwt_encode_and_sign(const grpc_auth_json_key *json_key, const char *audience, gpr_timespec token_lifetime, const char *scope)
Definition: json_token.c:312