Class: OpenSSL::Timestamp::Request

Relationships & Source Files
Inherits:	Object
Defined in:	ext/openssl/ossl_ts.c

Overview

Allows to create timestamp requests or parse existing ones. A Request is also needed for creating timestamps from scratch with Factory. When created from scratch, some default values are set:

version is set to 1
cert_requested is set to true
algorithm, message_imprint, policy_id, and nonce are set to false

Class Method Summary

.new(file) ⇒ Request constructor

When creating a Request with the File or string parameter, the corresponding File or string must be DER-encoded.

Instance Attribute Summary

#algorithm ⇒ String rw

Returns the ‘short name’ of the object identifier that represents the algorithm that was used to create the message imprint digest.
#algorithm=("string") ⇒ String rw

Allows to set the object identifier or the ‘short name’ of the algorithm that was used to create the message imprint digest.
#cert_requested=(boolean) ⇒ Boolean rw

Specify whether the response shall contain the timestamp authority’s certificate or not.
#cert_requested? ⇒ Boolean rw

Indicates whether the response shall contain the timestamp authority’s certificate or not.
#message_imprint ⇒ String^? rw

Returns the message imprint (digest) of the data to be timestamped.
#message_imprint=("string") ⇒ String rw

Set the message imprint digest.
#nonce ⇒ BN^? rw

Returns the nonce (number used once) that the server shall include in its response.
#nonce=(number) ⇒ BN rw

Sets the nonce (number used once) that the server shall include in its response.
#policy_id ⇒ String^? rw

Returns the ‘short name’ of the object identifier that represents the timestamp policy under which the server shall create the timestamp.
#policy_id=("string") ⇒ String rw

Allows to set the object identifier that represents the timestamp policy under which the server shall create the timestamp.
#version ⇒ Integer rw

Returns the version of this request.
#version=(number) ⇒ Integer rw

Sets the version number for this Request.

Instance Method Summary

#to_der ⇒ DER-encoded string

DER-encodes this Request.
#to_text

Constructor Details

.new(file) ⇒ `Request` .new(string) ⇒ `Request` .new ⇒ `Request`

When creating a Request with the File or string parameter, the corresponding File or string must be DER-encoded.

[ GitHub ]

# File 'ext/openssl/ossl_ts.c', line 202


static VALUE
ossl_ts_req_initialize(int argc, VALUE *argv, VALUE self)
{
    TS_REQ *ts_req = DATA_PTR(self);
    BIO *in;
    VALUE arg;

    if(rb_scan_args(argc, argv, "01", &arg) == 0) {
        return self;
    }

    arg = ossl_to_der_if_possible(arg);
    in = ossl_obj2bio(&arg);
    ts_req = d2i_TS_REQ_bio(in, &ts_req);
    BIO_free(in);
    if (!ts_req) {
        DATA_PTR(self) = NULL;
        ossl_raise(eTimestampError, "Error when decoding the timestamp request");
    }
    DATA_PTR(self) = ts_req;

    return self;
}

Instance Attribute Details

#algorithm ⇒ `String` (rw)

Returns the ‘short name’ of the object identifier that represents the algorithm that was used to create the message imprint digest.

[ GitHub ]

# File 'ext/openssl/ossl_ts.c', line 233


static VALUE
ossl_ts_req_get_algorithm(VALUE self)
{
    TS_REQ *req;
    TS_MSG_IMPRINT *mi;
    X509_ALGOR *algor;
    const ASN1_OBJECT *obj;

    GetTSRequest(self, req);
    mi = TS_REQ_get_msg_imprint(req);
    algor = TS_MSG_IMPRINT_get_algo(mi);
    X509_ALGOR_get0(&obj, NULL, NULL, algor);
    return get_asn1obj(obj);
}

#algorithm=("string") ⇒ `String` (rw)

Allows to set the object identifier or the ‘short name’ of the algorithm that was used to create the message imprint digest.

Example:

request.algorithm = "SHA1"

[ GitHub ]

# File 'ext/openssl/ossl_ts.c', line 258


static VALUE
ossl_ts_req_set_algorithm(VALUE self, VALUE algo)
{
    TS_REQ *req;
    TS_MSG_IMPRINT *mi;
    ASN1_OBJECT *obj;
    X509_ALGOR *algor;

    GetTSRequest(self, req);
    obj = obj_to_asn1obj(algo);
    mi = TS_REQ_get_msg_imprint(req);
    algor = TS_MSG_IMPRINT_get_algo(mi);
    if (!X509_ALGOR_set0(algor, obj, V_ASN1_NULL, NULL)) {
        ASN1_OBJECT_free(obj);
        ossl_raise(eTimestampError, "X509_ALGOR_set0");
    }

    return algo;
}

#cert_requested=(boolean) ⇒ `Boolean` (rw)

Specify whether the response shall contain the timestamp authority’s certificate or not. The default value is true.

[ GitHub ]

# File 'ext/openssl/ossl_ts.c', line 472


static VALUE
ossl_ts_req_set_cert_requested(VALUE self, VALUE requested)
{
    TS_REQ *req;

    GetTSRequest(self, req);
    TS_REQ_set_cert_req(req, RTEST(requested));

    return requested;
}

#cert_requested? ⇒ `Boolean` (rw)

Indicates whether the response shall contain the timestamp authority’s certificate or not.

[ GitHub ]

# File 'ext/openssl/ossl_ts.c', line 456


static VALUE
ossl_ts_req_get_cert_requested(VALUE self)
{
    TS_REQ *req;

    GetTSRequest(self, req);
    return TS_REQ_get_cert_req(req) ? Qtrue: Qfalse;
}

#message_imprint ⇒ `String`^? (rw)

Returns the message imprint (digest) of the data to be timestamped.

[ GitHub ]

# File 'ext/openssl/ossl_ts.c', line 284


static VALUE
ossl_ts_req_get_msg_imprint(VALUE self)
{
    TS_REQ *req;
    TS_MSG_IMPRINT *mi;
    ASN1_OCTET_STRING *hashed_msg;
    VALUE ret;

    GetTSRequest(self, req);
    mi = TS_REQ_get_msg_imprint(req);
    hashed_msg = TS_MSG_IMPRINT_get_msg(mi);

    ret = rb_str_new((const char *)hashed_msg->data, hashed_msg->length);

    return ret;
}

#message_imprint=("string") ⇒ `String` (rw)

Set the message imprint digest.

[ GitHub ]

# File 'ext/openssl/ossl_ts.c', line 307


static VALUE
ossl_ts_req_set_msg_imprint(VALUE self, VALUE hash)
{
    TS_REQ *req;
    TS_MSG_IMPRINT *mi;
    StringValue(hash);

    GetTSRequest(self, req);
    mi = TS_REQ_get_msg_imprint(req);
    if (!TS_MSG_IMPRINT_set_msg(mi, (unsigned char *)RSTRING_PTR(hash), RSTRING_LENINT(hash)))
        ossl_raise(eTimestampError, "TS_MSG_IMPRINT_set_msg");

    return hash;
}

#nonce ⇒ BN^? (rw)

Returns the nonce (number used once) that the server shall include in its response.

[ GitHub ]

# File 'ext/openssl/ossl_ts.c', line 413


static VALUE
ossl_ts_req_get_nonce(VALUE self)
{
    TS_REQ *req;
    const ASN1_INTEGER * nonce;

    GetTSRequest(self, req);
    if (!(nonce = TS_REQ_get_nonce(req)))
        return Qnil;
    return asn1integer_to_num(nonce);
}

#nonce=(number) ⇒ BN (rw)

Sets the nonce (number used once) that the server shall include in its response. If the nonce is set, the server must return the same nonce value in a valid Response.

[ GitHub ]

# File 'ext/openssl/ossl_ts.c', line 433


static VALUE
ossl_ts_req_set_nonce(VALUE self, VALUE num)
{
    TS_REQ *req;
    ASN1_INTEGER *nonce;
    int ok;

    GetTSRequest(self, req);
    nonce = num_to_asn1integer(num, NULL);
    ok = TS_REQ_set_nonce(req, nonce);
    ASN1_INTEGER_free(nonce);
    if (!ok)
        ossl_raise(eTimestampError, NULL);
    return num;
}

#policy_id ⇒ `String`^? (rw)

Returns the ‘short name’ of the object identifier that represents the timestamp policy under which the server shall create the timestamp.

[ GitHub ]

# File 'ext/openssl/ossl_ts.c', line 366


static VALUE
ossl_ts_req_get_policy_id(VALUE self)
{
    TS_REQ *req;

    GetTSRequest(self, req);
    if (!TS_REQ_get_policy_id(req))
        return Qnil;
    return get_asn1obj(TS_REQ_get_policy_id(req));
}

#policy_id=("string") ⇒ `String` (rw)

Allows to set the object identifier that represents the timestamp policy under which the server shall create the timestamp. This may be left nil, implying that the timestamp server will issue the timestamp using some default policy.

Example:

request.policy_id = "1.2.3.4.5"

[ GitHub ]

# File 'ext/openssl/ossl_ts.c', line 389


static VALUE
ossl_ts_req_set_policy_id(VALUE self, VALUE oid)
{
    TS_REQ *req;
    ASN1_OBJECT *obj;
    int ok;

    GetTSRequest(self, req);
    obj = obj_to_asn1obj(oid);
    ok = TS_REQ_set_policy_id(req, obj);
    ASN1_OBJECT_free(obj);
    if (!ok)
        ossl_raise(eTimestampError, "TS_REQ_set_policy_id");

    return oid;
}

#version ⇒ Integer (rw)

Returns the version of this request. 1 is the default value.

[ GitHub ]

# File 'ext/openssl/ossl_ts.c', line 328


static VALUE
ossl_ts_req_get_version(VALUE self)
{
    TS_REQ *req;

    GetTSRequest(self, req);
    return LONG2NUM(TS_REQ_get_version(req));
}

#version=(number) ⇒ Integer (rw)

Sets the version number for this Request. This should be 1 for compliant servers.

[ GitHub ]

# File 'ext/openssl/ossl_ts.c', line 344


static VALUE
ossl_ts_req_set_version(VALUE self, VALUE version)
{
    TS_REQ *req;
    long ver;

    if ((ver = NUM2LONG(version)) < 0)
        ossl_raise(eTimestampError, "version must be >= 0!");
    GetTSRequest(self, req);
    if (!TS_REQ_set_version(req, ver))
        ossl_raise(eTimestampError, "TS_REQ_set_version");

    return version;
}

Instance Method Details

#to_der ⇒ `DER`-`encoded` `string`

DER-encodes this Request.

[ GitHub ]

# File 'ext/openssl/ossl_ts.c', line 489


static VALUE
ossl_ts_req_to_der(VALUE self)
{
    TS_REQ *req;
    TS_MSG_IMPRINT *mi;
    X509_ALGOR *algo;
    const ASN1_OBJECT *obj;
    ASN1_OCTET_STRING *hashed_msg;

    GetTSRequest(self, req);
    mi = TS_REQ_get_msg_imprint(req);

    algo = TS_MSG_IMPRINT_get_algo(mi);
    X509_ALGOR_get0(&obj, NULL, NULL, algo);
    if (OBJ_obj2nid(obj) == NID_undef)
        ossl_raise(eTimestampError, "Message imprint missing algorithm");

    hashed_msg = TS_MSG_IMPRINT_get_msg(mi);
    if (!hashed_msg->length)
        ossl_raise(eTimestampError, "Message imprint missing hashed message");

    return asn1_to_der((void *)req, (int (*)(void *, unsigned char **))i2d_TS_REQ);
}

#to_text

[ GitHub ]

# File 'ext/openssl/ossl_ts.c', line 513


static VALUE
ossl_ts_req_to_text(VALUE self)
{
    TS_REQ *req;
    BIO *out;

    GetTSRequest(self, req);

    out = BIO_new(BIO_s_mem());
    if (!out) ossl_raise(eTimestampError, NULL);

    if (!TS_REQ_print_bio(out, req)) {
        BIO_free(out);
        ossl_raise(eTimestampError, NULL);
    }

    return ossl_membio2str(out);
}

Class: OpenSSL::Timestamp::Request

Overview

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(file) ⇒ Request .new(string) ⇒ Request .new ⇒ Request

Instance Attribute Details

#algorithm ⇒ String (rw)

#algorithm=("string") ⇒ String (rw)

Example:

#cert_requested=(boolean) ⇒ Boolean (rw)

#cert_requested? ⇒ Boolean (rw)

#message_imprint ⇒ String? (rw)

#message_imprint=("string") ⇒ String (rw)

#nonce ⇒ BN? (rw)

#nonce=(number) ⇒ BN (rw)

#policy_id ⇒ String? (rw)

#policy_id=("string") ⇒ String (rw)

Example:

#version ⇒ Integer (rw)

#version=(number) ⇒ Integer (rw)

Instance Method Details

#to_der ⇒ DER-encoded string

#to_text

.new(file) ⇒ `Request` .new(string) ⇒ `Request` .new ⇒ `Request`

#algorithm ⇒ `String` (rw)

#algorithm=("string") ⇒ `String` (rw)

#cert_requested=(boolean) ⇒ `Boolean` (rw)

#cert_requested? ⇒ `Boolean` (rw)

#message_imprint ⇒ `String`^? (rw)

#message_imprint=("string") ⇒ `String` (rw)

#nonce ⇒ BN^? (rw)

#policy_id ⇒ `String`^? (rw)

#policy_id=("string") ⇒ `String` (rw)

#to_der ⇒ `DER`-`encoded` `string`