Class: OpenSSL::Timestamp::TokenInfo

Inherits:
Object
  • Object
show all
Defined in:
ext/openssl/ossl_ts.c,
ext/openssl/ossl_ts.c

Overview

Immutable and read-only representation of a timestamp token info from a Response.

Instance Method Summary collapse

Constructor Details

#initialize(der) ⇒ Object

Creates a TokenInfo from a File or string parameter, the corresponding File or string must be DER-encoded. Please note that TokenInfo is an immutable read-only class. If you’d like to create timestamps please refer to Factory instead.

call-seq:

OpenSSL::Timestamp::TokenInfo.new(file)    -> token-info
OpenSSL::Timestamp::TokenInfo.new(string)  -> token-info



868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
 
# File 'ext/openssl/ossl_ts.c', line 868

static VALUE
ossl_ts_token_info_initialize(VALUE self, VALUE der)
{
    TS_TST_INFO *info = DATA_PTR(self);
    BIO *in;

    der = ossl_to_der_if_possible(der);
    in  = ossl_obj2bio(&der);
    info = d2i_TS_TST_INFO_bio(in, &info);
    BIO_free(in);
    if (!info) {
        DATA_PTR(self) = NULL;
        ossl_raise(eTimestampError, "Error when decoding the timestamp token info");
    }
    DATA_PTR(self) = info;

    return self;
}

Instance Method Details

#algorithm ⇒ Object

Returns the ‘short name’ of the object identifier representing the algorithm that was used to derive the message imprint digest. For valid timestamps, this is the same value that was already given in the Request. If status is GRANTED or GRANTED_WITH_MODS, this is never nil.

Example:

algo = token_info.algorithm
puts algo                -> "SHA1"

call-seq:

token_info.algorithm -> string or nil



938
939
940
941
942
943
944
945
946
947
948
949
 
# File 'ext/openssl/ossl_ts.c', line 938

static VALUE
ossl_ts_token_info_get_algorithm(VALUE self)
{
    TS_TST_INFO *info;
    TS_MSG_IMPRINT *mi;
    X509_ALGOR *algo;

    GetTSTokenInfo(self, info);
    mi = TS_TST_INFO_get_msg_imprint(info);
    algo = TS_MSG_IMPRINT_get_algo(mi);
    return get_asn1obj(algo->algorithm);
}

#gen_time ⇒ Object

Returns time when this timestamp token was created. If status is GRANTED or GRANTED_WITH_MODS, this is never nil.

call-seq:

token_info.gen_time -> Time



1003
1004
1005
1006
1007
1008
1009
1010
 
# File 'ext/openssl/ossl_ts.c', line 1003

static VALUE
ossl_ts_token_info_get_gen_time(VALUE self)
{
    TS_TST_INFO *info;

    GetTSTokenInfo(self, info);
    return asn1time_to_time(TS_TST_INFO_get_time(info));
}

#message_imprint ⇒ Object

Returns the message imprint digest. For valid timestamps, this is the same value that was already given in the Request. If status is GRANTED or GRANTED_WITH_MODS, this is never nil.

Example:

mi = token_info.msg_imprint
puts mi                -> "DEADBEEF"

call-seq:

token_info.msg_imprint -> string.



963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
 
# File 'ext/openssl/ossl_ts.c', line 963

static VALUE
ossl_ts_token_info_get_msg_imprint(VALUE self)
{
    TS_TST_INFO *info;
    TS_MSG_IMPRINT *mi;
    ASN1_OCTET_STRING *hashed_msg;
    VALUE ret;

    GetTSTokenInfo(self, info);
    mi = TS_TST_INFO_get_msg_imprint(info);
    hashed_msg = TS_MSG_IMPRINT_get_msg(mi);
    ret = rb_str_new((const char *)hashed_msg->data, hashed_msg->length);

    return ret;
}

#nonce ⇒ Object

If the timestamp token is valid then this field contains the same nonce that was passed to the timestamp server in the initial Request.

call-seq:

token_info.nonce -> BN or nil



1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
 
# File 'ext/openssl/ossl_ts.c', line 1045

static VALUE
ossl_ts_token_info_get_nonce(VALUE self)
{
    TS_TST_INFO *info;
    const ASN1_INTEGER *nonce;

    GetTSTokenInfo(self, info);
    if (!(nonce = TS_TST_INFO_get_nonce(info)))
        return Qnil;

    return asn1integer_to_num(nonce);
}

#ordering ⇒ Object

If the ordering field is missing, or if the ordering field is present and set to false, then the genTime field only indicates the time at which the time-stamp token has been created by the TSA. In such a case, the ordering of time-stamp tokens issued by the same TSA or different TSAs is only possible when the difference between the genTime of the first time-stamp token and the genTime of the second time-stamp token is greater than the sum of the accuracies of the genTime for each time-stamp token.

If the ordering field is present and set to true, every time-stamp token from the same TSA can always be ordered based on the genTime field, regardless of the genTime accuracy.

call-seq:

token_info.ordering -> true, falses or nil



1029
1030
1031
1032
1033
1034
1035
1036
 
# File 'ext/openssl/ossl_ts.c', line 1029

static VALUE
ossl_ts_token_info_get_ordering(VALUE self)
{
    TS_TST_INFO *info;

    GetTSTokenInfo(self, info);
    return TS_TST_INFO_get_ordering(info) ? Qtrue : Qfalse;
}

#policy_id ⇒ Object

Returns the timestamp policy object identifier of the policy this timestamp was created under. If status is GRANTED or GRANTED_WITH_MODS, this is never nil.

Example:

id = token_info.policy_id
puts id                 -> "1.2.3.4.5"

call-seq:

token_info.policy_id -> string or nil



916
917
918
919
920
921
922
923
 
# File 'ext/openssl/ossl_ts.c', line 916

static VALUE
ossl_ts_token_info_get_policy_id(VALUE self)
{
    TS_TST_INFO *info;

    GetTSTokenInfo(self, info);
    return get_asn1obj(TS_TST_INFO_get_policy_id(info));
}

#serial_number ⇒ Object

Returns serial number of the timestamp token. This value shall never be the same for two timestamp tokens issued by a dedicated timestamp authority. If status is GRANTED or GRANTED_WITH_MODS, this is never nil.

call-seq:

token_info.serial_number -> BN or nil



987
988
989
990
991
992
993
994
 
# File 'ext/openssl/ossl_ts.c', line 987

static VALUE
ossl_ts_token_info_get_serial_number(VALUE self)
{
    TS_TST_INFO *info;

    GetTSTokenInfo(self, info);
    return asn1integer_to_num(TS_TST_INFO_get_serial(info));
}

#to_der ⇒ Object

Returns the TokenInfo in DER-encoded form.

call-seq:

token_info.to_der -> string



1064
1065
1066
1067
1068
1069
1070
1071
 
# File 'ext/openssl/ossl_ts.c', line 1064

static VALUE
ossl_ts_token_info_to_der(VALUE self)
{
    TS_TST_INFO *info;

    GetTSTokenInfo(self, info);
    return asn1_to_der((void *)info, (int (*)(void *, unsigned char **))i2d_TS_TST_INFO);
}

#version ⇒ Object

Returns the version number of the token info. With compliant servers, this value should be 1 if present. If status is GRANTED or GRANTED_WITH_MODS.

call-seq:

token_info.version -> Integer or nil



895
896
897
898
899
900
901
902
 
# File 'ext/openssl/ossl_ts.c', line 895

static VALUE
ossl_ts_token_info_get_version(VALUE self)
{
    TS_TST_INFO *info;

    GetTSTokenInfo(self, info);
    return LONG2NUM(TS_TST_INFO_get_version(info));
}