OpenSSL::Engine

类 OpenSSL :: Engine

Parent:Object

这个类是对 openssl 的 ENGINE 加密模块实现的访问。

公共类方法

by_id（名称）→引擎显示源代码

按id字符串指定的方式获取引擎

OpenSSL::Engine.by_id("openssl")
 => #<OpenSSL::Engine id="openssl" name="Software engine support">

请参阅当前加载引擎的引擎

static VALUE
ossl_engine_s_by_id(VALUE klass, VALUE id)
{
    ENGINE *e;
    VALUE obj;

    StringValueCStr(id
    ossl_engine_s_load(1, &id, klass
    obj = NewEngine(klass
    if(!(e = ENGINE_by_id(RSTRING_PTR(id))))
        ossl_raise(eEngineError, NULL
    SetEngine(obj, e
    if(rb_block_given_p()) rb_yield(obj
    if(!ENGINE_init(e))
        ossl_raise(eEngineError, NULL
    ENGINE_ctrl(e, ENGINE_CTRL_SET_PASSWORD_CALLBACK,
                0, NULL, (void(*)(void))ossl_pem_passwd_cb
    ossl_clear_error(

    return obj;
}

OpenSSL :: Engine.cleanup显示源文件

只有在通过:: load加载引擎时才需要运行清理。但是，建议在退出前运行清理。

请注意，这是必需的，并且只能在OpenSSL <1.1.0中使用。

static VALUE
ossl_engine_s_cleanup(VALUE self)
{
    ENGINE_cleanup(
    return Qnil;
}

引擎（）显示源

返回当前加载的引擎的数组。

static VALUE
ossl_engine_s_engines(VALUE klass)
{
    ENGINE *e;
    VALUE ary, obj;

    ary = rb_ary_new(
    for(e = ENGINE_get_first( e; e = ENGINE_get_next(e)){
        obj = NewEngine(klass
        /* Need a ref count of two here because of ENGINE_free being
         * called internally by OpenSSL when moving to the next ENGINE
         * and by us when releasing the ENGINE reference */
        ENGINE_up_ref(e
        SetEngine(obj, e
        rb_ary_push(ary, obj
    }

    return ary;
}

load（enginename = nil）显示源文件

此方法加载引擎。如果name为零，则所有内置引擎都被加载。否则，给定name的字符串将在运行时加载，并返回true。如果name没有找到，则返回零。

static VALUE
ossl_engine_s_load(int argc, VALUE *argv, VALUE klass)
{
#if !defined(HAVE_ENGINE_LOAD_BUILTIN_ENGINES)
    return Qnil;
#else
    VALUE name;

    rb_scan_args(argc, argv, "01", &name
    if(NIL_P(name)){
        ENGINE_load_builtin_engines(
        return Qtrue;
    }
    StringValueCStr(name
#ifndef OPENSSL_NO_STATIC_ENGINE
#if HAVE_ENGINE_LOAD_DYNAMIC
    OSSL_ENGINE_LOAD_IF_MATCH(dynamic
#endif
#if HAVE_ENGINE_LOAD_4758CCA
    OSSL_ENGINE_LOAD_IF_MATCH(4758cca
#endif
#if HAVE_ENGINE_LOAD_AEP
    OSSL_ENGINE_LOAD_IF_MATCH(aep
#endif
#if HAVE_ENGINE_LOAD_ATALLA
    OSSL_ENGINE_LOAD_IF_MATCH(atalla
#endif
#if HAVE_ENGINE_LOAD_CHIL
    OSSL_ENGINE_LOAD_IF_MATCH(chil
#endif
#if HAVE_ENGINE_LOAD_CSWIFT
    OSSL_ENGINE_LOAD_IF_MATCH(cswift
#endif
#if HAVE_ENGINE_LOAD_NURON
    OSSL_ENGINE_LOAD_IF_MATCH(nuron
#endif
#if HAVE_ENGINE_LOAD_SUREWARE
    OSSL_ENGINE_LOAD_IF_MATCH(sureware
#endif
#if HAVE_ENGINE_LOAD_UBSEC
    OSSL_ENGINE_LOAD_IF_MATCH(ubsec
#endif
#if HAVE_ENGINE_LOAD_PADLOCK
    OSSL_ENGINE_LOAD_IF_MATCH(padlock
#endif
#if HAVE_ENGINE_LOAD_CAPI
    OSSL_ENGINE_LOAD_IF_MATCH(capi
#endif
#if HAVE_ENGINE_LOAD_GMP
    OSSL_ENGINE_LOAD_IF_MATCH(gmp
#endif
#if HAVE_ENGINE_LOAD_GOST
    OSSL_ENGINE_LOAD_IF_MATCH(gost
#endif
#if HAVE_ENGINE_LOAD_CRYPTODEV
    OSSL_ENGINE_LOAD_IF_MATCH(cryptodev
#endif
#if HAVE_ENGINE_LOAD_AESNI
    OSSL_ENGINE_LOAD_IF_MATCH(aesni
#endif
#endif
#ifdef HAVE_ENGINE_LOAD_OPENBSD_DEV_CRYPTO
    OSSL_ENGINE_LOAD_IF_MATCH(openbsd_dev_crypto
#endif
    OSSL_ENGINE_LOAD_IF_MATCH(openssl
    rb_warning("no such builtin loader for `%"PRIsVALUE"'", name
    return Qnil;
#endif /* HAVE_ENGINE_LOAD_BUILTIN_ENGINES */
}

公共实例方法

密码（名称）→OpenSSL ::密码显示源

如果在此引擎中name可用，则返回 OpenSSL :: Cipher 。

如果密码不可用，将引发EngineError。

e = OpenSSL::Engine.by_id("openssl")
 => #<OpenSSL::Engine id="openssl" name="Software engine support">
e.cipher("RC4")
 => #<OpenSSL::Cipher:0x007fc5cacc3048>

static VALUE
ossl_engine_get_cipher(VALUE self, VALUE name)
{
    ENGINE *e;
    const EVP_CIPHER *ciph, *tmp;
    int nid;

    tmp = EVP_get_cipherbyname(StringValueCStr(name)
    if(!tmp) ossl_raise(eEngineError, "no such cipher `%"PRIsVALUE"'", name
    nid = EVP_CIPHER_nid(tmp
    GetEngine(self, e
    ciph = ENGINE_get_cipher(e, nid
    if(!ciph) ossl_raise(eEngineError, NULL

    return ossl_cipher_new(ciph
}

cmds（）显示资源

返回当前引擎的命令定义数组

static VALUE
ossl_engine_get_cmds(VALUE self)
{
    ENGINE *e;
    const ENGINE_CMD_DEFN *defn, *p;
    VALUE ary, tmp;

    GetEngine(self, e
    ary = rb_ary_new(
    if ((defn = ENGINE_get_cmd_defns(e)) != NULL){
        for (p = defn; p->cmd_num > 0; p++){
            tmp = rb_ary_new(
            rb_ary_push(tmp, rb_str_new2(p->cmd_name)
            rb_ary_push(tmp, rb_str_new2(p->cmd_desc)
            rb_ary_push(tmp, ossl_engine_cmd_flag_to_name(p->cmd_flags)
            rb_ary_push(ary, tmp
        }
    }

    return ary;
}

ctrl_cmd（command，value = nil）→引擎显示源码

发送给command这个引擎。

如果command失败，则引发 EngineError 。

static VALUE
ossl_engine_ctrl_cmd(int argc, VALUE *argv, VALUE self)
{
    ENGINE *e;
    VALUE cmd, val;
    int ret;

    GetEngine(self, e
    rb_scan_args(argc, argv, "11", &cmd, &val
    ret = ENGINE_ctrl_cmd_string(e, StringValueCStr(cmd),
                                 NIL_P(val) ? NULL : StringValueCStr(val), 0
    if (!ret) ossl_raise(eEngineError, NULL

    return self;
}

摘要（名称）→OpenSSL ::摘要显示源文件

这将返回一个 OpenSSL :: Digest by name。

如果摘要不可用，将引发EngineError。

e = OpenSSL::Engine.by_id("openssl")
  #=> #<OpenSSL::Engine id="openssl" name="Software engine support">
e.digest("SHA1")
  #=> #<OpenSSL::Digest: da39a3ee5e6b4b0d3255bfef95601890afd80709>
e.digest("zomg")
  #=> OpenSSL::Engine::EngineError: no such digest `zomg'

static VALUE
ossl_engine_get_digest(VALUE self, VALUE name)
{
    ENGINE *e;
    const EVP_MD *md, *tmp;
    int nid;

    tmp = EVP_get_digestbyname(StringValueCStr(name)
    if(!tmp) ossl_raise(eEngineError, "no such digest `%"PRIsVALUE"'", name
    nid = EVP_MD_nid(tmp
    GetEngine(self, e
    md = ENGINE_get_digest(e, nid
    if(!md) ossl_raise(eEngineError, NULL

    return ossl_digest_new(md
}

完成（）显示源

释放此引擎的所有内部结构引用。

如果引擎不可用，可能会引发 EngineError

static VALUE
ossl_engine_finish(VALUE self)
{
    ENGINE *e;

    GetEngine(self, e
    if(!ENGINE_finish(e)) ossl_raise(eEngineError, NULL

    return Qnil;
}

id（）显示源

获取此引擎的 ID

OpenSSL::Engine.load
OpenSSL::Engine.engines #=> [#<OpenSSL::Engine#>, ...]
OpenSSL::Engine.engines.first.id
  #=> "rsax"

static VALUE
ossl_engine_get_id(VALUE self)
{
    ENGINE *e;
    GetEngine(self, e
    return rb_str_new2(ENGINE_get_id(e)
}

inspect（）显示源文件

漂亮的打印这个引擎

static VALUE
ossl_engine_inspect(VALUE self)
{
    ENGINE *e;

    GetEngine(self, e
    return rb_sprintf("#<%"PRIsVALUE" id=\"%s\" name=\"%s\">",
                      rb_obj_class(self), ENGINE_get_id(e), ENGINE_get_name(e)
}

load_private_key（id = nil，data = nil）→OpenSSL :: PKey显示源文件

通过id和加载给定的私钥data。

一个 EngineError 引发的 OpenSSL :: PKey 不可用。

static VALUE
ossl_engine_load_privkey(int argc, VALUE *argv, VALUE self)
{
    ENGINE *e;
    EVP_PKEY *pkey;
    VALUE id, data, obj;
    char *sid, *sdata;

    rb_scan_args(argc, argv, "02", &id, &data
    sid = NIL_P(id) ? NULL : StringValueCStr(id
    sdata = NIL_P(data) ? NULL : StringValueCStr(data
    GetEngine(self, e
    pkey = ENGINE_load_private_key(e, sid, NULL, sdata
    if (!pkey) ossl_raise(eEngineError, NULL
    obj = ossl_pkey_new(pkey
    OSSL_PKEY_SET_PRIVATE(obj

    return obj;
}

load_public_key（id = nil，data = nil）→OpenSSL :: PKey显示源文件

通过id和加载给定的私钥data。

一个 EngineError 引发的 OpenSSL :: PKey不可用。

static VALUE
ossl_engine_load_pubkey(int argc, VALUE *argv, VALUE self)
{
    ENGINE *e;
    EVP_PKEY *pkey;
    VALUE id, data;
    char *sid, *sdata;

    rb_scan_args(argc, argv, "02", &id, &data
    sid = NIL_P(id) ? NULL : StringValueCStr(id
    sdata = NIL_P(data) ? NULL : StringValueCStr(data
    GetEngine(self, e
    pkey = ENGINE_load_public_key(e, sid, NULL, sdata
    if (!pkey) ossl_raise(eEngineError, NULL

    return ossl_pkey_new(pkey
}

name（）显示源文件

获取此引擎的描述性名称

OpenSSL::Engine.load
OpenSSL::Engine.engines #=> [#<OpenSSL::Engine#>, ...]
OpenSSL::Engine.engines.first.name
  #=> "RSAX engine support"

static VALUE
ossl_engine_get_name(VALUE self)
{
    ENGINE *e;
    GetEngine(self, e
    return rb_str_new2(ENGINE_get_name(e)
}

set_default（标志）显示源

使用给定值设置此引擎的默认值flag。

这些标志用于控制算法方法的组合。

flag 可以是以下之一，其他标志可用取决于您的操作系统。

所有标志

0xFFFF

没有标志

0x0000

另见<openssl / engine.h>

static VALUE
ossl_engine_set_default(VALUE self, VALUE flag)
{
    ENGINE *e;
    int f = NUM2INT(flag

    GetEngine(self, e
    ENGINE_set_default(e, f

    return Qtrue;
}