1 /*
2 *
3 * Copyright 2015 gRPC authors.
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 *
17 */
18
19 #include <ruby/ruby.h>
20
21 #include "rb_server_credentials.h"
22
23 #include "rb_grpc.h"
24 #include "rb_grpc_imports.generated.h"
25
26 #include <grpc/grpc.h>
27 #include <grpc/grpc_security.h>
28 #include <grpc/support/log.h>
29
30 /* grpc_rb_cServerCredentials is the ruby class that proxies
31 grpc_server_credentials. */
32 static VALUE grpc_rb_cServerCredentials = Qnil;
33
34 /* grpc_rb_server_credentials wraps a grpc_server_credentials. It provides a
35 peer ruby object, 'mark' to hold references to objects involved in
36 constructing the server credentials. */
37 typedef struct grpc_rb_server_credentials {
38 /* Holder of ruby objects involved in constructing the server credentials */
39 VALUE mark;
40 /* The actual server credentials */
41 grpc_server_credentials* wrapped;
42 } grpc_rb_server_credentials;
43
44 /* Destroys the server credentials instances. */
grpc_rb_server_credentials_free_internal(void * p)45 static void grpc_rb_server_credentials_free_internal(void* p) {
46 grpc_rb_server_credentials* wrapper = NULL;
47 if (p == NULL) {
48 return;
49 };
50 wrapper = (grpc_rb_server_credentials*)p;
51
52 /* Delete the wrapped object if the mark object is Qnil, which indicates that
53 no other object is the actual owner. */
54 if (wrapper->wrapped != NULL && wrapper->mark == Qnil) {
55 grpc_server_credentials_release(wrapper->wrapped);
56 wrapper->wrapped = NULL;
57 }
58
59 xfree(p);
60 }
61
62 /* Destroys the server credentials instances. */
grpc_rb_server_credentials_free(void * p)63 static void grpc_rb_server_credentials_free(void* p) {
64 grpc_rb_server_credentials_free_internal(p);
65 }
66
67 /* Protects the mark object from GC */
grpc_rb_server_credentials_mark(void * p)68 static void grpc_rb_server_credentials_mark(void* p) {
69 grpc_rb_server_credentials* wrapper = NULL;
70 if (p == NULL) {
71 return;
72 }
73 wrapper = (grpc_rb_server_credentials*)p;
74
75 /* If it's not already cleaned up, mark the mark object */
76 if (wrapper->mark != Qnil) {
77 rb_gc_mark(wrapper->mark);
78 }
79 }
80
81 static const rb_data_type_t grpc_rb_server_credentials_data_type = {
82 "grpc_server_credentials",
83 {grpc_rb_server_credentials_mark,
84 grpc_rb_server_credentials_free,
85 GRPC_RB_MEMSIZE_UNAVAILABLE,
86 {NULL, NULL}},
87 NULL,
88 NULL,
89 #ifdef RUBY_TYPED_FREE_IMMEDIATELY
90 RUBY_TYPED_FREE_IMMEDIATELY
91 #endif
92 };
93
94 /* Allocates ServerCredential instances.
95 Provides safe initial defaults for the instance fields. */
grpc_rb_server_credentials_alloc(VALUE cls)96 static VALUE grpc_rb_server_credentials_alloc(VALUE cls) {
97 grpc_ruby_init();
98 grpc_rb_server_credentials* wrapper = ALLOC(grpc_rb_server_credentials);
99 wrapper->wrapped = NULL;
100 wrapper->mark = Qnil;
101 return TypedData_Wrap_Struct(cls, &grpc_rb_server_credentials_data_type,
102 wrapper);
103 }
104
105 /* The attribute used on the mark object to preserve the pem_root_certs. */
106 static ID id_pem_root_certs;
107
108 /* The attribute used on the mark object to preserve the pem_key_certs */
109 static ID id_pem_key_certs;
110
111 /* The key used to access the pem cert in a key_cert pair hash */
112 static VALUE sym_cert_chain;
113
114 /* The key used to access the pem private key in a key_cert pair hash */
115 static VALUE sym_private_key;
116
117 /*
118 call-seq:
119 creds = ServerCredentials.new(nil,
120 [{private_key: <pem_private_key1>,
121 {cert_chain: <pem_cert_chain1>}],
122 force_client_auth)
123 creds = ServerCredentials.new(pem_root_certs,
124 [{private_key: <pem_private_key1>,
125 {cert_chain: <pem_cert_chain1>}],
126 force_client_auth)
127
128 pem_root_certs: (optional) PEM encoding of the server root certificate
129 pem_private_key: (required) PEM encoding of the server's private keys
130 force_client_auth: indicatees
131
132 Initializes ServerCredential instances. */
grpc_rb_server_credentials_init(VALUE self,VALUE pem_root_certs,VALUE pem_key_certs,VALUE force_client_auth)133 static VALUE grpc_rb_server_credentials_init(VALUE self, VALUE pem_root_certs,
134 VALUE pem_key_certs,
135 VALUE force_client_auth) {
136 grpc_rb_server_credentials* wrapper = NULL;
137 grpc_server_credentials* creds = NULL;
138 grpc_ssl_pem_key_cert_pair* key_cert_pairs = NULL;
139 VALUE cert = Qnil;
140 VALUE key = Qnil;
141 VALUE key_cert = Qnil;
142 int auth_client = 0;
143 long num_key_certs = 0;
144 int i;
145
146 if (NIL_P(force_client_auth) ||
147 !(force_client_auth == Qfalse || force_client_auth == Qtrue)) {
148 rb_raise(rb_eTypeError,
149 "bad force_client_auth: got:<%s> want: <True|False|nil>",
150 rb_obj_classname(force_client_auth));
151 return Qnil;
152 }
153 if (NIL_P(pem_key_certs) || TYPE(pem_key_certs) != T_ARRAY) {
154 rb_raise(rb_eTypeError, "bad pem_key_certs: got:<%s> want: <Array>",
155 rb_obj_classname(pem_key_certs));
156 return Qnil;
157 }
158 num_key_certs = RARRAY_LEN(pem_key_certs);
159 if (num_key_certs == 0) {
160 rb_raise(rb_eTypeError, "bad pem_key_certs: it had no elements");
161 return Qnil;
162 }
163 for (i = 0; i < num_key_certs; i++) {
164 key_cert = rb_ary_entry(pem_key_certs, i);
165 if (key_cert == Qnil) {
166 rb_raise(rb_eTypeError,
167 "could not create a server credential: nil key_cert");
168 return Qnil;
169 } else if (TYPE(key_cert) != T_HASH) {
170 rb_raise(rb_eTypeError,
171 "could not create a server credential: want <Hash>, got <%s>",
172 rb_obj_classname(key_cert));
173 return Qnil;
174 } else if (rb_hash_aref(key_cert, sym_private_key) == Qnil) {
175 rb_raise(rb_eTypeError,
176 "could not create a server credential: want nil private key");
177 return Qnil;
178 } else if (rb_hash_aref(key_cert, sym_cert_chain) == Qnil) {
179 rb_raise(rb_eTypeError,
180 "could not create a server credential: want nil cert chain");
181 return Qnil;
182 }
183 }
184
185 auth_client = TYPE(force_client_auth) == T_TRUE
186 ? GRPC_SSL_REQUEST_AND_REQUIRE_CLIENT_CERTIFICATE_AND_VERIFY
187 : GRPC_SSL_DONT_REQUEST_CLIENT_CERTIFICATE;
188 key_cert_pairs = ALLOC_N(grpc_ssl_pem_key_cert_pair, num_key_certs);
189 for (i = 0; i < num_key_certs; i++) {
190 key_cert = rb_ary_entry(pem_key_certs, i);
191 key = rb_hash_aref(key_cert, sym_private_key);
192 cert = rb_hash_aref(key_cert, sym_cert_chain);
193 key_cert_pairs[i].private_key = RSTRING_PTR(key);
194 key_cert_pairs[i].cert_chain = RSTRING_PTR(cert);
195 }
196
197 TypedData_Get_Struct(self, grpc_rb_server_credentials,
198 &grpc_rb_server_credentials_data_type, wrapper);
199
200 if (pem_root_certs == Qnil) {
201 creds = grpc_ssl_server_credentials_create_ex(
202 NULL, key_cert_pairs, num_key_certs, auth_client, NULL);
203 } else {
204 creds = grpc_ssl_server_credentials_create_ex(RSTRING_PTR(pem_root_certs),
205 key_cert_pairs, num_key_certs,
206 auth_client, NULL);
207 }
208 xfree(key_cert_pairs);
209 if (creds == NULL) {
210 rb_raise(rb_eRuntimeError,
211 "the call to grpc_ssl_server_credentials_create_ex() failed, "
212 "could not create a credentials, see "
213 "https://github.com/grpc/grpc/blob/master/TROUBLESHOOTING.md for "
214 "debugging tips");
215 return Qnil;
216 }
217 wrapper->wrapped = creds;
218
219 /* Add the input objects as hidden fields to preserve them. */
220 rb_ivar_set(self, id_pem_key_certs, pem_key_certs);
221 rb_ivar_set(self, id_pem_root_certs, pem_root_certs);
222
223 return self;
224 }
225
Init_grpc_server_credentials()226 void Init_grpc_server_credentials() {
227 grpc_rb_cServerCredentials =
228 rb_define_class_under(grpc_rb_mGrpcCore, "ServerCredentials", rb_cObject);
229
230 /* Allocates an object managed by the ruby runtime */
231 rb_define_alloc_func(grpc_rb_cServerCredentials,
232 grpc_rb_server_credentials_alloc);
233
234 /* Provides a ruby constructor and support for dup/clone. */
235 rb_define_method(grpc_rb_cServerCredentials, "initialize",
236 grpc_rb_server_credentials_init, 3);
237 rb_define_method(grpc_rb_cServerCredentials, "initialize_copy",
238 grpc_rb_cannot_init_copy, 1);
239
240 id_pem_key_certs = rb_intern("__pem_key_certs");
241 id_pem_root_certs = rb_intern("__pem_root_certs");
242 sym_private_key = ID2SYM(rb_intern("private_key"));
243 sym_cert_chain = ID2SYM(rb_intern("cert_chain"));
244 }
245
246 /* Gets the wrapped grpc_server_credentials from the ruby wrapper */
grpc_rb_get_wrapped_server_credentials(VALUE v)247 grpc_server_credentials* grpc_rb_get_wrapped_server_credentials(VALUE v) {
248 grpc_rb_server_credentials* wrapper = NULL;
249 Check_TypedStruct(v, &grpc_rb_server_credentials_data_type);
250 TypedData_Get_Struct(v, grpc_rb_server_credentials,
251 &grpc_rb_server_credentials_data_type, wrapper);
252 return wrapper->wrapped;
253 }
254
255 /* Check if v is kind of ServerCredentials */
grpc_rb_is_server_credentials(VALUE v)256 bool grpc_rb_is_server_credentials(VALUE v) {
257 return rb_typeddata_is_kind_of(v, &grpc_rb_server_credentials_data_type);
258 }
259