jboeuf | befd265 | 2014-12-12 15:39:47 -0800 | [diff] [blame] | 1 | /* |
| 2 | * |
David Garcia Quintas | 3598d44 | 2016-03-15 14:53:05 -0700 | [diff] [blame] | 3 | * Copyright 2015-2016, Google Inc. |
jboeuf | befd265 | 2014-12-12 15:39:47 -0800 | [diff] [blame] | 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 | |
Craig Tiller | 9a4dddd | 2016-03-25 17:08:13 -0700 | [diff] [blame] | 34 | #ifndef GRPC_CORE_LIB_SECURITY_JSON_TOKEN_H |
| 35 | #define GRPC_CORE_LIB_SECURITY_JSON_TOKEN_H |
jboeuf | befd265 | 2014-12-12 15:39:47 -0800 | [diff] [blame] | 36 | |
| 37 | #include <grpc/support/slice.h> |
| 38 | #include <openssl/rsa.h> |
| 39 | |
Julien Boeuf | 5400606 | 2015-07-07 19:13:04 -0700 | [diff] [blame] | 40 | #include "src/core/json/json.h" |
| 41 | |
Julien Boeuf | f47a5cb | 2015-02-18 12:24:08 -0800 | [diff] [blame] | 42 | /* --- Constants. --- */ |
| 43 | |
| 44 | #define GRPC_JWT_OAUTH2_AUDIENCE "https://www.googleapis.com/oauth2/v3/token" |
| 45 | |
Julien Boeuf | 5400606 | 2015-07-07 19:13:04 -0700 | [diff] [blame] | 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 | |
jboeuf | 1a809c0 | 2014-12-19 15:44:30 -0800 | [diff] [blame] | 50 | /* --- auth_json_key parsing. --- */ |
jboeuf | befd265 | 2014-12-12 15:39:47 -0800 | [diff] [blame] | 51 | |
| 52 | typedef struct { |
Julien Boeuf | 7551606 | 2015-03-07 15:10:30 -0800 | [diff] [blame] | 53 | const char *type; |
jboeuf | befd265 | 2014-12-12 15:39:47 -0800 | [diff] [blame] | 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. */ |
jboeuf | 1a809c0 | 2014-12-19 15:44:30 -0800 | [diff] [blame] | 61 | int grpc_auth_json_key_is_valid(const grpc_auth_json_key *json_key); |
jboeuf | befd265 | 2014-12-12 15:39:47 -0800 | [diff] [blame] | 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 | |
Julien Boeuf | 5400606 | 2015-07-07 19:13:04 -0700 | [diff] [blame] | 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 | |
jboeuf | befd265 | 2014-12-12 15:39:47 -0800 | [diff] [blame] | 72 | /* Destructs the object. */ |
| 73 | void grpc_auth_json_key_destruct(grpc_auth_json_key *json_key); |
| 74 | |
jboeuf | ab4f914 | 2014-12-16 16:32:39 -0800 | [diff] [blame] | 75 | /* --- json token encoding and signing. --- */ |
| 76 | |
| 77 | /* Caller is responsible for calling gpr_free on the returned value. May return |
Julien Boeuf | f47a5cb | 2015-02-18 12:24:08 -0800 | [diff] [blame] | 78 | NULL on invalid input. The scope parameter may be NULL. */ |
jboeuf | ab4f914 | 2014-12-16 16:32:39 -0800 | [diff] [blame] | 79 | char *grpc_jwt_encode_and_sign(const grpc_auth_json_key *json_key, |
Julien Boeuf | f47a5cb | 2015-02-18 12:24:08 -0800 | [diff] [blame] | 80 | const char *audience, |
| 81 | gpr_timespec token_lifetime, const char *scope); |
jboeuf | ab4f914 | 2014-12-16 16:32:39 -0800 | [diff] [blame] | 82 | |
jboeuf | 1a809c0 | 2014-12-19 15:44:30 -0800 | [diff] [blame] | 83 | /* Override encode_and_sign function for testing. */ |
| 84 | typedef char *(*grpc_jwt_encode_and_sign_override)( |
Julien Boeuf | f47a5cb | 2015-02-18 12:24:08 -0800 | [diff] [blame] | 85 | const grpc_auth_json_key *json_key, const char *audience, |
| 86 | gpr_timespec token_lifetime, const char *scope); |
jboeuf | 1a809c0 | 2014-12-19 15:44:30 -0800 | [diff] [blame] | 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 | |
Julien Boeuf | 7551606 | 2015-03-07 15:10:30 -0800 | [diff] [blame] | 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 | |
Julien Boeuf | 5400606 | 2015-07-07 19:13:04 -0700 | [diff] [blame] | 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 | |
Julien Boeuf | 7551606 | 2015-03-07 15:10:30 -0800 | [diff] [blame] | 115 | /* Destructs the object. */ |
| 116 | void grpc_auth_refresh_token_destruct(grpc_auth_refresh_token *refresh_token); |
| 117 | |
Craig Tiller | 9a4dddd | 2016-03-25 17:08:13 -0700 | [diff] [blame] | 118 | #endif /* GRPC_CORE_LIB_SECURITY_JSON_TOKEN_H */ |