mirror of
https://github.com/ruby/ruby.git
synced 2022-11-09 12:17:21 -05:00
f6612203fa
We store the reverse reference to the Ruby object in the OpenSSL struct for use from OpenSSL callback functions. To prevent the Ruby object from being relocated by GC.compact, we must "pin" it by calling rb_gc_mark(). https://github.com/ruby/openssl/commit/a6ba9f894f
986 lines
26 KiB
C
986 lines
26 KiB
C
/*
|
|
* 'OpenSSL for Ruby' project
|
|
* Copyright (C) 2001-2002 Michal Rokos <m.rokos@sh.cvut.cz>
|
|
* All rights reserved.
|
|
*/
|
|
/*
|
|
* This program is licensed under the same licence as Ruby.
|
|
* (See the file 'LICENCE'.)
|
|
*/
|
|
#include "ossl.h"
|
|
|
|
#define NewX509Store(klass) \
|
|
TypedData_Wrap_Struct((klass), &ossl_x509store_type, 0)
|
|
#define SetX509Store(obj, st) do { \
|
|
if (!(st)) { \
|
|
ossl_raise(rb_eRuntimeError, "STORE wasn't initialized!"); \
|
|
} \
|
|
RTYPEDDATA_DATA(obj) = (st); \
|
|
} while (0)
|
|
#define GetX509Store(obj, st) do { \
|
|
TypedData_Get_Struct((obj), X509_STORE, &ossl_x509store_type, (st)); \
|
|
if (!(st)) { \
|
|
ossl_raise(rb_eRuntimeError, "STORE wasn't initialized!"); \
|
|
} \
|
|
} while (0)
|
|
|
|
#define NewX509StCtx(klass) \
|
|
TypedData_Wrap_Struct((klass), &ossl_x509stctx_type, 0)
|
|
#define SetX509StCtx(obj, ctx) do { \
|
|
if (!(ctx)) { \
|
|
ossl_raise(rb_eRuntimeError, "STORE_CTX wasn't initialized!"); \
|
|
} \
|
|
RTYPEDDATA_DATA(obj) = (ctx); \
|
|
} while (0)
|
|
#define GetX509StCtx(obj, ctx) do { \
|
|
TypedData_Get_Struct((obj), X509_STORE_CTX, &ossl_x509stctx_type, (ctx)); \
|
|
if (!(ctx)) { \
|
|
ossl_raise(rb_eRuntimeError, "STORE_CTX is out of scope!"); \
|
|
} \
|
|
} while (0)
|
|
|
|
/*
|
|
* Verify callback stuff
|
|
*/
|
|
static int stctx_ex_verify_cb_idx, store_ex_verify_cb_idx;
|
|
static VALUE ossl_x509stctx_new(X509_STORE_CTX *);
|
|
|
|
struct ossl_verify_cb_args {
|
|
VALUE proc;
|
|
VALUE preverify_ok;
|
|
VALUE store_ctx;
|
|
};
|
|
|
|
static VALUE
|
|
ossl_x509stctx_new_i(VALUE arg)
|
|
{
|
|
return ossl_x509stctx_new((X509_STORE_CTX *)arg);
|
|
}
|
|
|
|
static VALUE
|
|
call_verify_cb_proc(VALUE arg)
|
|
{
|
|
struct ossl_verify_cb_args *args = (struct ossl_verify_cb_args *)arg;
|
|
return rb_funcall(args->proc, rb_intern("call"), 2,
|
|
args->preverify_ok, args->store_ctx);
|
|
}
|
|
|
|
int
|
|
ossl_verify_cb_call(VALUE proc, int ok, X509_STORE_CTX *ctx)
|
|
{
|
|
VALUE rctx, ret;
|
|
struct ossl_verify_cb_args args;
|
|
int state;
|
|
|
|
if (NIL_P(proc))
|
|
return ok;
|
|
|
|
ret = Qfalse;
|
|
rctx = rb_protect(ossl_x509stctx_new_i, (VALUE)ctx, &state);
|
|
if (state) {
|
|
rb_set_errinfo(Qnil);
|
|
rb_warn("StoreContext initialization failure");
|
|
}
|
|
else {
|
|
args.proc = proc;
|
|
args.preverify_ok = ok ? Qtrue : Qfalse;
|
|
args.store_ctx = rctx;
|
|
ret = rb_protect(call_verify_cb_proc, (VALUE)&args, &state);
|
|
if (state) {
|
|
rb_set_errinfo(Qnil);
|
|
rb_warn("exception in verify_callback is ignored");
|
|
}
|
|
RTYPEDDATA_DATA(rctx) = NULL;
|
|
}
|
|
if (ret == Qtrue) {
|
|
X509_STORE_CTX_set_error(ctx, X509_V_OK);
|
|
ok = 1;
|
|
}
|
|
else {
|
|
if (X509_STORE_CTX_get_error(ctx) == X509_V_OK)
|
|
X509_STORE_CTX_set_error(ctx, X509_V_ERR_CERT_REJECTED);
|
|
ok = 0;
|
|
}
|
|
|
|
return ok;
|
|
}
|
|
|
|
/*
|
|
* Classes
|
|
*/
|
|
VALUE cX509Store;
|
|
VALUE cX509StoreContext;
|
|
VALUE eX509StoreError;
|
|
|
|
static void
|
|
ossl_x509store_mark(void *ptr)
|
|
{
|
|
X509_STORE *store = ptr;
|
|
rb_gc_mark((VALUE)X509_STORE_get_ex_data(store, store_ex_verify_cb_idx));
|
|
}
|
|
|
|
static void
|
|
ossl_x509store_free(void *ptr)
|
|
{
|
|
X509_STORE_free(ptr);
|
|
}
|
|
|
|
static const rb_data_type_t ossl_x509store_type = {
|
|
"OpenSSL/X509/STORE",
|
|
{
|
|
ossl_x509store_mark, ossl_x509store_free,
|
|
},
|
|
0, 0, RUBY_TYPED_FREE_IMMEDIATELY,
|
|
};
|
|
|
|
/*
|
|
* Public functions
|
|
*/
|
|
X509_STORE *
|
|
GetX509StorePtr(VALUE obj)
|
|
{
|
|
X509_STORE *store;
|
|
|
|
GetX509Store(obj, store);
|
|
|
|
return store;
|
|
}
|
|
|
|
/*
|
|
* Private functions
|
|
*/
|
|
static int
|
|
x509store_verify_cb(int ok, X509_STORE_CTX *ctx)
|
|
{
|
|
VALUE proc;
|
|
|
|
proc = (VALUE)X509_STORE_CTX_get_ex_data(ctx, stctx_ex_verify_cb_idx);
|
|
if (!proc)
|
|
proc = (VALUE)X509_STORE_get_ex_data(X509_STORE_CTX_get0_store(ctx),
|
|
store_ex_verify_cb_idx);
|
|
if (!proc)
|
|
return ok;
|
|
|
|
return ossl_verify_cb_call(proc, ok, ctx);
|
|
}
|
|
|
|
static VALUE
|
|
ossl_x509store_alloc(VALUE klass)
|
|
{
|
|
X509_STORE *store;
|
|
VALUE obj;
|
|
|
|
obj = NewX509Store(klass);
|
|
if ((store = X509_STORE_new()) == NULL)
|
|
ossl_raise(eX509StoreError, "X509_STORE_new");
|
|
SetX509Store(obj, store);
|
|
|
|
return obj;
|
|
}
|
|
|
|
/*
|
|
* General callback for OpenSSL verify
|
|
*/
|
|
static VALUE
|
|
ossl_x509store_set_vfy_cb(VALUE self, VALUE cb)
|
|
{
|
|
X509_STORE *store;
|
|
|
|
GetX509Store(self, store);
|
|
X509_STORE_set_ex_data(store, store_ex_verify_cb_idx, (void *)cb);
|
|
rb_iv_set(self, "@verify_callback", cb);
|
|
|
|
return cb;
|
|
}
|
|
|
|
|
|
/*
|
|
* call-seq:
|
|
* X509::Store.new => store
|
|
*
|
|
* Creates a new X509::Store.
|
|
*/
|
|
static VALUE
|
|
ossl_x509store_initialize(int argc, VALUE *argv, VALUE self)
|
|
{
|
|
X509_STORE *store;
|
|
|
|
GetX509Store(self, store);
|
|
if (argc != 0)
|
|
rb_warn("OpenSSL::X509::Store.new does not take any arguments");
|
|
#if !defined(HAVE_OPAQUE_OPENSSL)
|
|
/* [Bug #405] [Bug #1678] [Bug #3000]; already fixed? */
|
|
store->ex_data.sk = NULL;
|
|
#endif
|
|
X509_STORE_set_verify_cb(store, x509store_verify_cb);
|
|
ossl_x509store_set_vfy_cb(self, Qnil);
|
|
|
|
/* last verification status */
|
|
rb_iv_set(self, "@error", Qnil);
|
|
rb_iv_set(self, "@error_string", Qnil);
|
|
rb_iv_set(self, "@chain", Qnil);
|
|
rb_iv_set(self, "@time", Qnil);
|
|
|
|
return self;
|
|
}
|
|
|
|
/*
|
|
* call-seq:
|
|
* store.flags = flags
|
|
*
|
|
* Sets the default flags used by certificate chain verification performed with
|
|
* the Store.
|
|
*
|
|
* _flags_ consists of zero or more of the constants defined in OpenSSL::X509
|
|
* with name V_FLAG_* or'ed together.
|
|
*
|
|
* OpenSSL::X509::StoreContext#flags= can be used to change the flags for a
|
|
* single verification operation.
|
|
*
|
|
* See also the man page X509_VERIFY_PARAM_set_flags(3).
|
|
*/
|
|
static VALUE
|
|
ossl_x509store_set_flags(VALUE self, VALUE flags)
|
|
{
|
|
X509_STORE *store;
|
|
long f = NUM2LONG(flags);
|
|
|
|
GetX509Store(self, store);
|
|
X509_STORE_set_flags(store, f);
|
|
|
|
return flags;
|
|
}
|
|
|
|
/*
|
|
* call-seq:
|
|
* store.purpose = purpose
|
|
*
|
|
* Sets the store's default verification purpose. If specified,
|
|
* the verifications on the store will check every certificate's extensions are
|
|
* consistent with the purpose. The purpose is specified by constants:
|
|
*
|
|
* * X509::PURPOSE_SSL_CLIENT
|
|
* * X509::PURPOSE_SSL_SERVER
|
|
* * X509::PURPOSE_NS_SSL_SERVER
|
|
* * X509::PURPOSE_SMIME_SIGN
|
|
* * X509::PURPOSE_SMIME_ENCRYPT
|
|
* * X509::PURPOSE_CRL_SIGN
|
|
* * X509::PURPOSE_ANY
|
|
* * X509::PURPOSE_OCSP_HELPER
|
|
* * X509::PURPOSE_TIMESTAMP_SIGN
|
|
*
|
|
* OpenSSL::X509::StoreContext#purpose= can be used to change the value for a
|
|
* single verification operation.
|
|
*
|
|
* See also the man page X509_VERIFY_PARAM_set_purpose(3).
|
|
*/
|
|
static VALUE
|
|
ossl_x509store_set_purpose(VALUE self, VALUE purpose)
|
|
{
|
|
X509_STORE *store;
|
|
int p = NUM2INT(purpose);
|
|
|
|
GetX509Store(self, store);
|
|
X509_STORE_set_purpose(store, p);
|
|
|
|
return purpose;
|
|
}
|
|
|
|
/*
|
|
* call-seq:
|
|
* store.trust = trust
|
|
*
|
|
* Sets the default trust settings used by the certificate verification with
|
|
* the store.
|
|
*
|
|
* OpenSSL::X509::StoreContext#trust= can be used to change the value for a
|
|
* single verification operation.
|
|
*
|
|
* See also the man page X509_VERIFY_PARAM_set_trust(3).
|
|
*/
|
|
static VALUE
|
|
ossl_x509store_set_trust(VALUE self, VALUE trust)
|
|
{
|
|
X509_STORE *store;
|
|
int t = NUM2INT(trust);
|
|
|
|
GetX509Store(self, store);
|
|
X509_STORE_set_trust(store, t);
|
|
|
|
return trust;
|
|
}
|
|
|
|
/*
|
|
* call-seq:
|
|
* store.time = time
|
|
*
|
|
* Sets the time to be used in the certificate verifications with the store.
|
|
* By default, if not specified, the current system time is used.
|
|
*
|
|
* OpenSSL::X509::StoreContext#time= can be used to change the value for a
|
|
* single verification operation.
|
|
*
|
|
* See also the man page X509_VERIFY_PARAM_set_time(3).
|
|
*/
|
|
static VALUE
|
|
ossl_x509store_set_time(VALUE self, VALUE time)
|
|
{
|
|
rb_iv_set(self, "@time", time);
|
|
return time;
|
|
}
|
|
|
|
/*
|
|
* call-seq:
|
|
* store.add_file(file) -> self
|
|
*
|
|
* Adds the certificates in _file_ to the certificate store. _file_ is the path
|
|
* to the file, and the file contains one or more certificates in PEM format
|
|
* concatenated together.
|
|
*
|
|
* See also the man page X509_LOOKUP_file(3).
|
|
*/
|
|
static VALUE
|
|
ossl_x509store_add_file(VALUE self, VALUE file)
|
|
{
|
|
X509_STORE *store;
|
|
X509_LOOKUP *lookup;
|
|
const char *path;
|
|
|
|
GetX509Store(self, store);
|
|
path = StringValueCStr(file);
|
|
lookup = X509_STORE_add_lookup(store, X509_LOOKUP_file());
|
|
if (!lookup)
|
|
ossl_raise(eX509StoreError, "X509_STORE_add_lookup");
|
|
if (X509_LOOKUP_load_file(lookup, path, X509_FILETYPE_PEM) != 1)
|
|
ossl_raise(eX509StoreError, "X509_LOOKUP_load_file");
|
|
#if OPENSSL_VERSION_NUMBER < 0x10101000 || defined(LIBRESSL_VERSION_NUMBER)
|
|
/*
|
|
* X509_load_cert_crl_file() which is called from X509_LOOKUP_load_file()
|
|
* did not check the return value of X509_STORE_add_{cert,crl}(), leaking
|
|
* "cert already in hash table" errors on the error queue, if duplicate
|
|
* certificates are found. This will be fixed by OpenSSL 1.1.1.
|
|
*/
|
|
ossl_clear_error();
|
|
#endif
|
|
|
|
return self;
|
|
}
|
|
|
|
/*
|
|
* call-seq:
|
|
* store.add_path(path) -> self
|
|
*
|
|
* Adds _path_ as the hash dir to be looked up by the store.
|
|
*
|
|
* See also the man page X509_LOOKUP_hash_dir(3).
|
|
*/
|
|
static VALUE
|
|
ossl_x509store_add_path(VALUE self, VALUE dir)
|
|
{
|
|
X509_STORE *store;
|
|
X509_LOOKUP *lookup;
|
|
const char *path;
|
|
|
|
GetX509Store(self, store);
|
|
path = StringValueCStr(dir);
|
|
lookup = X509_STORE_add_lookup(store, X509_LOOKUP_hash_dir());
|
|
if (!lookup)
|
|
ossl_raise(eX509StoreError, "X509_STORE_add_lookup");
|
|
if (X509_LOOKUP_add_dir(lookup, path, X509_FILETYPE_PEM) != 1)
|
|
ossl_raise(eX509StoreError, "X509_LOOKUP_add_dir");
|
|
|
|
return self;
|
|
}
|
|
|
|
/*
|
|
* call-seq:
|
|
* store.set_default_paths
|
|
*
|
|
* Configures _store_ to look up CA certificates from the system default
|
|
* certificate store as needed basis. The location of the store can usually be
|
|
* determined by:
|
|
*
|
|
* * OpenSSL::X509::DEFAULT_CERT_FILE
|
|
* * OpenSSL::X509::DEFAULT_CERT_DIR
|
|
*
|
|
* See also the man page X509_STORE_set_default_paths(3).
|
|
*/
|
|
static VALUE
|
|
ossl_x509store_set_default_paths(VALUE self)
|
|
{
|
|
X509_STORE *store;
|
|
|
|
GetX509Store(self, store);
|
|
if (X509_STORE_set_default_paths(store) != 1)
|
|
ossl_raise(eX509StoreError, "X509_STORE_set_default_paths");
|
|
|
|
return Qnil;
|
|
}
|
|
|
|
/*
|
|
* call-seq:
|
|
* store.add_cert(cert) -> self
|
|
*
|
|
* Adds the OpenSSL::X509::Certificate _cert_ to the certificate store.
|
|
*
|
|
* See also the man page X509_STORE_add_cert(3).
|
|
*/
|
|
static VALUE
|
|
ossl_x509store_add_cert(VALUE self, VALUE arg)
|
|
{
|
|
X509_STORE *store;
|
|
X509 *cert;
|
|
|
|
cert = GetX509CertPtr(arg); /* NO NEED TO DUP */
|
|
GetX509Store(self, store);
|
|
if (X509_STORE_add_cert(store, cert) != 1)
|
|
ossl_raise(eX509StoreError, "X509_STORE_add_cert");
|
|
|
|
return self;
|
|
}
|
|
|
|
/*
|
|
* call-seq:
|
|
* store.add_crl(crl) -> self
|
|
*
|
|
* Adds the OpenSSL::X509::CRL _crl_ to the store.
|
|
*
|
|
* See also the man page X509_STORE_add_crl(3).
|
|
*/
|
|
static VALUE
|
|
ossl_x509store_add_crl(VALUE self, VALUE arg)
|
|
{
|
|
X509_STORE *store;
|
|
X509_CRL *crl;
|
|
|
|
crl = GetX509CRLPtr(arg); /* NO NEED TO DUP */
|
|
GetX509Store(self, store);
|
|
if (X509_STORE_add_crl(store, crl) != 1)
|
|
ossl_raise(eX509StoreError, "X509_STORE_add_crl");
|
|
|
|
return self;
|
|
}
|
|
|
|
static VALUE ossl_x509stctx_get_err(VALUE);
|
|
static VALUE ossl_x509stctx_get_err_string(VALUE);
|
|
static VALUE ossl_x509stctx_get_chain(VALUE);
|
|
|
|
/*
|
|
* call-seq:
|
|
* store.verify(cert, chain = nil) -> true | false
|
|
*
|
|
* Performs a certificate verification on the OpenSSL::X509::Certificate _cert_.
|
|
*
|
|
* _chain_ can be an array of OpenSSL::X509::Certificate that is used to
|
|
* construct the certificate chain.
|
|
*
|
|
* If a block is given, it overrides the callback set by #verify_callback=.
|
|
*
|
|
* After finishing the verification, the error information can be retrieved by
|
|
* #error, #error_string, and the resulting complete certificate chain can be
|
|
* retrieved by #chain.
|
|
*/
|
|
static VALUE
|
|
ossl_x509store_verify(int argc, VALUE *argv, VALUE self)
|
|
{
|
|
VALUE cert, chain;
|
|
VALUE ctx, proc, result;
|
|
|
|
rb_scan_args(argc, argv, "11", &cert, &chain);
|
|
ctx = rb_funcall(cX509StoreContext, rb_intern("new"), 3, self, cert, chain);
|
|
proc = rb_block_given_p() ? rb_block_proc() :
|
|
rb_iv_get(self, "@verify_callback");
|
|
rb_iv_set(ctx, "@verify_callback", proc);
|
|
result = rb_funcall(ctx, rb_intern("verify"), 0);
|
|
|
|
rb_iv_set(self, "@error", ossl_x509stctx_get_err(ctx));
|
|
rb_iv_set(self, "@error_string", ossl_x509stctx_get_err_string(ctx));
|
|
rb_iv_set(self, "@chain", ossl_x509stctx_get_chain(ctx));
|
|
|
|
return result;
|
|
}
|
|
|
|
/*
|
|
* Private functions
|
|
*/
|
|
static void
|
|
ossl_x509stctx_mark(void *ptr)
|
|
{
|
|
X509_STORE_CTX *ctx = ptr;
|
|
rb_gc_mark((VALUE)X509_STORE_CTX_get_ex_data(ctx, stctx_ex_verify_cb_idx));
|
|
}
|
|
|
|
static void
|
|
ossl_x509stctx_free(void *ptr)
|
|
{
|
|
X509_STORE_CTX *ctx = ptr;
|
|
if (X509_STORE_CTX_get0_untrusted(ctx))
|
|
sk_X509_pop_free(X509_STORE_CTX_get0_untrusted(ctx), X509_free);
|
|
if (X509_STORE_CTX_get0_cert(ctx))
|
|
X509_free(X509_STORE_CTX_get0_cert(ctx));
|
|
X509_STORE_CTX_free(ctx);
|
|
}
|
|
|
|
static const rb_data_type_t ossl_x509stctx_type = {
|
|
"OpenSSL/X509/STORE_CTX",
|
|
{
|
|
ossl_x509stctx_mark, ossl_x509stctx_free,
|
|
},
|
|
0, 0, RUBY_TYPED_FREE_IMMEDIATELY,
|
|
};
|
|
|
|
static VALUE
|
|
ossl_x509stctx_alloc(VALUE klass)
|
|
{
|
|
X509_STORE_CTX *ctx;
|
|
VALUE obj;
|
|
|
|
obj = NewX509StCtx(klass);
|
|
if ((ctx = X509_STORE_CTX_new()) == NULL)
|
|
ossl_raise(eX509StoreError, "X509_STORE_CTX_new");
|
|
SetX509StCtx(obj, ctx);
|
|
|
|
return obj;
|
|
}
|
|
|
|
static VALUE
|
|
ossl_x509stctx_new(X509_STORE_CTX *ctx)
|
|
{
|
|
VALUE obj;
|
|
|
|
obj = NewX509StCtx(cX509StoreContext);
|
|
SetX509StCtx(obj, ctx);
|
|
|
|
return obj;
|
|
}
|
|
|
|
static VALUE ossl_x509stctx_set_flags(VALUE, VALUE);
|
|
static VALUE ossl_x509stctx_set_purpose(VALUE, VALUE);
|
|
static VALUE ossl_x509stctx_set_trust(VALUE, VALUE);
|
|
static VALUE ossl_x509stctx_set_time(VALUE, VALUE);
|
|
|
|
/*
|
|
* call-seq:
|
|
* StoreContext.new(store, cert = nil, untrusted = nil)
|
|
*
|
|
* Sets up a StoreContext for a verification of the X.509 certificate _cert_.
|
|
*/
|
|
static VALUE
|
|
ossl_x509stctx_initialize(int argc, VALUE *argv, VALUE self)
|
|
{
|
|
VALUE store, cert, chain, t;
|
|
X509_STORE_CTX *ctx;
|
|
X509_STORE *x509st;
|
|
X509 *x509 = NULL;
|
|
STACK_OF(X509) *x509s = NULL;
|
|
int state;
|
|
|
|
rb_scan_args(argc, argv, "12", &store, &cert, &chain);
|
|
GetX509StCtx(self, ctx);
|
|
GetX509Store(store, x509st);
|
|
if (!NIL_P(cert))
|
|
x509 = DupX509CertPtr(cert); /* NEED TO DUP */
|
|
if (!NIL_P(chain)) {
|
|
x509s = ossl_protect_x509_ary2sk(chain, &state);
|
|
if (state) {
|
|
X509_free(x509);
|
|
rb_jump_tag(state);
|
|
}
|
|
}
|
|
if (X509_STORE_CTX_init(ctx, x509st, x509, x509s) != 1){
|
|
X509_free(x509);
|
|
sk_X509_pop_free(x509s, X509_free);
|
|
ossl_raise(eX509StoreError, "X509_STORE_CTX_init");
|
|
}
|
|
if (!NIL_P(t = rb_iv_get(store, "@time")))
|
|
ossl_x509stctx_set_time(self, t);
|
|
rb_iv_set(self, "@verify_callback", rb_iv_get(store, "@verify_callback"));
|
|
rb_iv_set(self, "@cert", cert);
|
|
|
|
return self;
|
|
}
|
|
|
|
/*
|
|
* call-seq:
|
|
* stctx.verify -> true | false
|
|
*
|
|
* Performs the certificate verification using the parameters set to _stctx_.
|
|
*
|
|
* See also the man page X509_verify_cert(3).
|
|
*/
|
|
static VALUE
|
|
ossl_x509stctx_verify(VALUE self)
|
|
{
|
|
X509_STORE_CTX *ctx;
|
|
|
|
GetX509StCtx(self, ctx);
|
|
X509_STORE_CTX_set_ex_data(ctx, stctx_ex_verify_cb_idx,
|
|
(void *)rb_iv_get(self, "@verify_callback"));
|
|
|
|
switch (X509_verify_cert(ctx)) {
|
|
case 1:
|
|
return Qtrue;
|
|
case 0:
|
|
ossl_clear_error();
|
|
return Qfalse;
|
|
default:
|
|
ossl_raise(eX509CertError, "X509_verify_cert");
|
|
}
|
|
}
|
|
|
|
/*
|
|
* call-seq:
|
|
* stctx.chain -> nil | Array of X509::Certificate
|
|
*
|
|
* Returns the verified chain.
|
|
*
|
|
* See also the man page X509_STORE_CTX_set0_verified_chain(3).
|
|
*/
|
|
static VALUE
|
|
ossl_x509stctx_get_chain(VALUE self)
|
|
{
|
|
X509_STORE_CTX *ctx;
|
|
const STACK_OF(X509) *chain;
|
|
|
|
GetX509StCtx(self, ctx);
|
|
chain = X509_STORE_CTX_get0_chain(ctx);
|
|
if (!chain)
|
|
return Qnil; /* Could be an empty array instead? */
|
|
return ossl_x509_sk2ary(chain);
|
|
}
|
|
|
|
/*
|
|
* call-seq:
|
|
* stctx.error -> Integer
|
|
*
|
|
* Returns the error code of _stctx_. This is typically called after #verify
|
|
* is done, or from the verification callback set to
|
|
* OpenSSL::X509::Store#verify_callback=.
|
|
*
|
|
* See also the man page X509_STORE_CTX_get_error(3).
|
|
*/
|
|
static VALUE
|
|
ossl_x509stctx_get_err(VALUE self)
|
|
{
|
|
X509_STORE_CTX *ctx;
|
|
|
|
GetX509StCtx(self, ctx);
|
|
|
|
return INT2NUM(X509_STORE_CTX_get_error(ctx));
|
|
}
|
|
|
|
/*
|
|
* call-seq:
|
|
* stctx.error = error_code
|
|
*
|
|
* Sets the error code of _stctx_. This is used by the verification callback
|
|
* set to OpenSSL::X509::Store#verify_callback=.
|
|
*
|
|
* See also the man page X509_STORE_CTX_set_error(3).
|
|
*/
|
|
static VALUE
|
|
ossl_x509stctx_set_error(VALUE self, VALUE err)
|
|
{
|
|
X509_STORE_CTX *ctx;
|
|
|
|
GetX509StCtx(self, ctx);
|
|
X509_STORE_CTX_set_error(ctx, NUM2INT(err));
|
|
|
|
return err;
|
|
}
|
|
|
|
/*
|
|
* call-seq:
|
|
* stctx.error_string -> String
|
|
*
|
|
* Returns the human readable error string corresponding to the error code
|
|
* retrieved by #error.
|
|
*
|
|
* See also the man page X509_verify_cert_error_string(3).
|
|
*/
|
|
static VALUE
|
|
ossl_x509stctx_get_err_string(VALUE self)
|
|
{
|
|
X509_STORE_CTX *ctx;
|
|
long err;
|
|
|
|
GetX509StCtx(self, ctx);
|
|
err = X509_STORE_CTX_get_error(ctx);
|
|
|
|
return rb_str_new2(X509_verify_cert_error_string(err));
|
|
}
|
|
|
|
/*
|
|
* call-seq:
|
|
* stctx.error_depth -> Integer
|
|
*
|
|
* Returns the depth of the chain. This is used in combination with #error.
|
|
*
|
|
* See also the man page X509_STORE_CTX_get_error_depth(3).
|
|
*/
|
|
static VALUE
|
|
ossl_x509stctx_get_err_depth(VALUE self)
|
|
{
|
|
X509_STORE_CTX *ctx;
|
|
|
|
GetX509StCtx(self, ctx);
|
|
|
|
return INT2NUM(X509_STORE_CTX_get_error_depth(ctx));
|
|
}
|
|
|
|
/*
|
|
* call-seq:
|
|
* stctx.current_cert -> X509::Certificate
|
|
*
|
|
* Returns the certificate which caused the error.
|
|
*
|
|
* See also the man page X509_STORE_CTX_get_current_cert(3).
|
|
*/
|
|
static VALUE
|
|
ossl_x509stctx_get_curr_cert(VALUE self)
|
|
{
|
|
X509_STORE_CTX *ctx;
|
|
|
|
GetX509StCtx(self, ctx);
|
|
|
|
return ossl_x509_new(X509_STORE_CTX_get_current_cert(ctx));
|
|
}
|
|
|
|
/*
|
|
* call-seq:
|
|
* stctx.current_crl -> X509::CRL
|
|
*
|
|
* Returns the CRL which caused the error.
|
|
*
|
|
* See also the man page X509_STORE_CTX_get_current_crl(3).
|
|
*/
|
|
static VALUE
|
|
ossl_x509stctx_get_curr_crl(VALUE self)
|
|
{
|
|
X509_STORE_CTX *ctx;
|
|
X509_CRL *crl;
|
|
|
|
GetX509StCtx(self, ctx);
|
|
crl = X509_STORE_CTX_get0_current_crl(ctx);
|
|
if (!crl)
|
|
return Qnil;
|
|
|
|
return ossl_x509crl_new(crl);
|
|
}
|
|
|
|
/*
|
|
* call-seq:
|
|
* stctx.flags = flags
|
|
*
|
|
* Sets the verification flags to the context. This overrides the default value
|
|
* set by Store#flags=.
|
|
*
|
|
* See also the man page X509_VERIFY_PARAM_set_flags(3).
|
|
*/
|
|
static VALUE
|
|
ossl_x509stctx_set_flags(VALUE self, VALUE flags)
|
|
{
|
|
X509_STORE_CTX *store;
|
|
long f = NUM2LONG(flags);
|
|
|
|
GetX509StCtx(self, store);
|
|
X509_STORE_CTX_set_flags(store, f);
|
|
|
|
return flags;
|
|
}
|
|
|
|
/*
|
|
* call-seq:
|
|
* stctx.purpose = purpose
|
|
*
|
|
* Sets the purpose of the context. This overrides the default value set by
|
|
* Store#purpose=.
|
|
*
|
|
* See also the man page X509_VERIFY_PARAM_set_purpose(3).
|
|
*/
|
|
static VALUE
|
|
ossl_x509stctx_set_purpose(VALUE self, VALUE purpose)
|
|
{
|
|
X509_STORE_CTX *store;
|
|
int p = NUM2INT(purpose);
|
|
|
|
GetX509StCtx(self, store);
|
|
X509_STORE_CTX_set_purpose(store, p);
|
|
|
|
return purpose;
|
|
}
|
|
|
|
/*
|
|
* call-seq:
|
|
* stctx.trust = trust
|
|
*
|
|
* Sets the trust settings of the context. This overrides the default value set
|
|
* by Store#trust=.
|
|
*
|
|
* See also the man page X509_VERIFY_PARAM_set_trust(3).
|
|
*/
|
|
static VALUE
|
|
ossl_x509stctx_set_trust(VALUE self, VALUE trust)
|
|
{
|
|
X509_STORE_CTX *store;
|
|
int t = NUM2INT(trust);
|
|
|
|
GetX509StCtx(self, store);
|
|
X509_STORE_CTX_set_trust(store, t);
|
|
|
|
return trust;
|
|
}
|
|
|
|
/*
|
|
* call-seq:
|
|
* stctx.time = time
|
|
*
|
|
* Sets the time used in the verification. If not set, the current time is used.
|
|
*
|
|
* See also the man page X509_VERIFY_PARAM_set_time(3).
|
|
*/
|
|
static VALUE
|
|
ossl_x509stctx_set_time(VALUE self, VALUE time)
|
|
{
|
|
X509_STORE_CTX *store;
|
|
long t;
|
|
|
|
t = NUM2LONG(rb_Integer(time));
|
|
GetX509StCtx(self, store);
|
|
X509_STORE_CTX_set_time(store, 0, t);
|
|
|
|
return time;
|
|
}
|
|
|
|
/*
|
|
* INIT
|
|
*/
|
|
void
|
|
Init_ossl_x509store(void)
|
|
{
|
|
#undef rb_intern
|
|
#if 0
|
|
mOSSL = rb_define_module("OpenSSL");
|
|
eOSSLError = rb_define_class_under(mOSSL, "OpenSSLError", rb_eStandardError);
|
|
mX509 = rb_define_module_under(mOSSL, "X509");
|
|
#endif
|
|
|
|
/* Register ext_data slot for verify callback Proc */
|
|
stctx_ex_verify_cb_idx = X509_STORE_CTX_get_ex_new_index(0, (void *)"stctx_ex_verify_cb_idx", 0, 0, 0);
|
|
if (stctx_ex_verify_cb_idx < 0)
|
|
ossl_raise(eOSSLError, "X509_STORE_CTX_get_ex_new_index");
|
|
store_ex_verify_cb_idx = X509_STORE_get_ex_new_index(0, (void *)"store_ex_verify_cb_idx", 0, 0, 0);
|
|
if (store_ex_verify_cb_idx < 0)
|
|
ossl_raise(eOSSLError, "X509_STORE_get_ex_new_index");
|
|
|
|
eX509StoreError = rb_define_class_under(mX509, "StoreError", eOSSLError);
|
|
|
|
/* Document-class: OpenSSL::X509::Store
|
|
*
|
|
* The X509 certificate store holds trusted CA certificates used to verify
|
|
* peer certificates.
|
|
*
|
|
* The easiest way to create a useful certificate store is:
|
|
*
|
|
* cert_store = OpenSSL::X509::Store.new
|
|
* cert_store.set_default_paths
|
|
*
|
|
* This will use your system's built-in certificates.
|
|
*
|
|
* If your system does not have a default set of certificates you can obtain
|
|
* a set extracted from Mozilla CA certificate store by cURL maintainers
|
|
* here: https://curl.haxx.se/docs/caextract.html (You may wish to use the
|
|
* firefox-db2pem.sh script to extract the certificates from a local install
|
|
* to avoid man-in-the-middle attacks.)
|
|
*
|
|
* After downloading or generating a cacert.pem from the above link you
|
|
* can create a certificate store from the pem file like this:
|
|
*
|
|
* cert_store = OpenSSL::X509::Store.new
|
|
* cert_store.add_file 'cacert.pem'
|
|
*
|
|
* The certificate store can be used with an SSLSocket like this:
|
|
*
|
|
* ssl_context = OpenSSL::SSL::SSLContext.new
|
|
* ssl_context.verify_mode = OpenSSL::SSL::VERIFY_PEER
|
|
* ssl_context.cert_store = cert_store
|
|
*
|
|
* tcp_socket = TCPSocket.open 'example.com', 443
|
|
*
|
|
* ssl_socket = OpenSSL::SSL::SSLSocket.new tcp_socket, ssl_context
|
|
*/
|
|
|
|
cX509Store = rb_define_class_under(mX509, "Store", rb_cObject);
|
|
/*
|
|
* The callback for additional certificate verification. It is invoked for
|
|
* each certificate in the chain and can be used to implement custom
|
|
* certificate verification conditions.
|
|
*
|
|
* The callback is invoked with two values, a boolean that indicates if the
|
|
* pre-verification by OpenSSL has succeeded or not, and the StoreContext in
|
|
* use.
|
|
*
|
|
* The callback can use StoreContext#error= to change the error code as
|
|
* needed. The callback must return either true or false.
|
|
*
|
|
* NOTE: any exception raised within the callback will be ignored.
|
|
*
|
|
* See also the man page X509_STORE_CTX_set_verify_cb(3).
|
|
*/
|
|
rb_attr(cX509Store, rb_intern("verify_callback"), 1, 0, Qfalse);
|
|
/*
|
|
* The error code set by the last call of #verify.
|
|
*
|
|
* See also StoreContext#error.
|
|
*/
|
|
rb_attr(cX509Store, rb_intern("error"), 1, 0, Qfalse);
|
|
/*
|
|
* The description for the error code set by the last call of #verify.
|
|
*
|
|
* See also StoreContext#error_string.
|
|
*/
|
|
rb_attr(cX509Store, rb_intern("error_string"), 1, 0, Qfalse);
|
|
/*
|
|
* The certificate chain constructed by the last call of #verify.
|
|
*
|
|
* See also StoreContext#chain.
|
|
*/
|
|
rb_attr(cX509Store, rb_intern("chain"), 1, 0, Qfalse);
|
|
rb_define_alloc_func(cX509Store, ossl_x509store_alloc);
|
|
rb_define_method(cX509Store, "initialize", ossl_x509store_initialize, -1);
|
|
rb_undef_method(cX509Store, "initialize_copy");
|
|
rb_define_method(cX509Store, "verify_callback=", ossl_x509store_set_vfy_cb, 1);
|
|
rb_define_method(cX509Store, "flags=", ossl_x509store_set_flags, 1);
|
|
rb_define_method(cX509Store, "purpose=", ossl_x509store_set_purpose, 1);
|
|
rb_define_method(cX509Store, "trust=", ossl_x509store_set_trust, 1);
|
|
rb_define_method(cX509Store, "time=", ossl_x509store_set_time, 1);
|
|
rb_define_method(cX509Store, "add_path", ossl_x509store_add_path, 1);
|
|
rb_define_method(cX509Store, "add_file", ossl_x509store_add_file, 1);
|
|
rb_define_method(cX509Store, "set_default_paths", ossl_x509store_set_default_paths, 0);
|
|
rb_define_method(cX509Store, "add_cert", ossl_x509store_add_cert, 1);
|
|
rb_define_method(cX509Store, "add_crl", ossl_x509store_add_crl, 1);
|
|
rb_define_method(cX509Store, "verify", ossl_x509store_verify, -1);
|
|
|
|
/*
|
|
* Document-class: OpenSSL::X509::StoreContext
|
|
*
|
|
* A StoreContext is used while validating a single certificate and holds
|
|
* the status involved.
|
|
*/
|
|
cX509StoreContext = rb_define_class_under(mX509,"StoreContext", rb_cObject);
|
|
rb_define_alloc_func(cX509StoreContext, ossl_x509stctx_alloc);
|
|
rb_define_method(cX509StoreContext, "initialize", ossl_x509stctx_initialize, -1);
|
|
rb_undef_method(cX509StoreContext, "initialize_copy");
|
|
rb_define_method(cX509StoreContext, "verify", ossl_x509stctx_verify, 0);
|
|
rb_define_method(cX509StoreContext, "chain", ossl_x509stctx_get_chain,0);
|
|
rb_define_method(cX509StoreContext, "error", ossl_x509stctx_get_err, 0);
|
|
rb_define_method(cX509StoreContext, "error=", ossl_x509stctx_set_error, 1);
|
|
rb_define_method(cX509StoreContext, "error_string", ossl_x509stctx_get_err_string,0);
|
|
rb_define_method(cX509StoreContext, "error_depth", ossl_x509stctx_get_err_depth, 0);
|
|
rb_define_method(cX509StoreContext, "current_cert", ossl_x509stctx_get_curr_cert, 0);
|
|
rb_define_method(cX509StoreContext, "current_crl", ossl_x509stctx_get_curr_crl, 0);
|
|
rb_define_method(cX509StoreContext, "flags=", ossl_x509stctx_set_flags, 1);
|
|
rb_define_method(cX509StoreContext, "purpose=", ossl_x509stctx_set_purpose, 1);
|
|
rb_define_method(cX509StoreContext, "trust=", ossl_x509stctx_set_trust, 1);
|
|
rb_define_method(cX509StoreContext, "time=", ossl_x509stctx_set_time, 1);
|
|
}
|