Class: OpenSSL::SSL::Session

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

Defined Under Namespace

Classes: SessionError

Instance Method Summary collapse

Constructor Details

#new(ssl_socket) ⇒ Session #new(string) ⇒ Session

Creates a new Session object from an instance of SSLSocket or DER/PEM encoded String.

Overloads:



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'ext/openssl/ossl_ssl_session.c', line 38

static VALUE
ossl_ssl_session_initialize(VALUE self, VALUE arg1)
{
    SSL_SESSION *ctx;

    if (RTYPEDDATA_DATA(self))
        ossl_raise(eSSLSession, "SSL Session already initialized");

    if (rb_obj_is_instance_of(arg1, cSSLSocket)) {
        SSL *ssl;

        GetSSL(arg1, ssl);

        if ((ctx = SSL_get1_session(ssl)) == NULL)
            ossl_raise(eSSLSession, "no session available");
    }
    else {
        BIO *in = ossl_obj2bio(&arg1);

        ctx = d2i_SSL_SESSION_bio(in, NULL);
        if (!ctx) {
            OSSL_BIO_reset(in);
            ctx = PEM_read_bio_SSL_SESSION(in, NULL, NULL, NULL);
        }
        BIO_free(in);
        if (!ctx)
            ossl_raise(rb_eArgError, "unknown type");
    }

    RTYPEDDATA_DATA(self) = ctx;

    return self;
}

Instance Method Details

#==(session2) ⇒ Boolean

Returns true if the two Session is the same, false if not.

Returns:

  • (Boolean) 


114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'ext/openssl/ossl_ssl_session.c', line 114

static VALUE ossl_ssl_session_eq(VALUE val1, VALUE val2)
{
	SSL_SESSION *ctx1, *ctx2;

	GetSSLSession(val1, ctx1);
	GetSSLSession(val2, ctx2);

	switch (ossl_SSL_SESSION_cmp(ctx1, ctx2)) {
	case 0:		return Qtrue;
	default:	return Qfalse;
	}
}

#id ⇒ String

Returns the Session ID.

Returns:

  • (String) 


212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'ext/openssl/ossl_ssl_session.c', line 212

static VALUE ossl_ssl_session_get_id(VALUE self)
{
	SSL_SESSION *ctx;
	const unsigned char *p = NULL;
	unsigned int i = 0;

	GetSSLSession(self, ctx);

	p = SSL_SESSION_get_id(ctx, &i);

	return rb_str_new((const char *) p, i);
}

#initialize_copy(other) ⇒ Object 



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'ext/openssl/ossl_ssl_session.c', line 72

static VALUE
ossl_ssl_session_initialize_copy(VALUE self, VALUE other)
{
    SSL_SESSION *sess, *sess_other, *sess_new;

    rb_check_frozen(self);
    sess = RTYPEDDATA_DATA(self); /* XXX */
    GetSSLSession(other, sess_other);

    sess_new = ASN1_dup((i2d_of_void *)i2d_SSL_SESSION, (d2i_of_void *)d2i_SSL_SESSION,
			(char *)sess_other);
    if (!sess_new)
	ossl_raise(eSSLSession, "ASN1_dup");

    RTYPEDDATA_DATA(self) = sess_new;
    SSL_SESSION_free(sess);

    return self;
}

#time ⇒ Time

Returns the time at which the session was established.

Returns:

  • (Time) 


133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'ext/openssl/ossl_ssl_session.c', line 133

static VALUE
ossl_ssl_session_get_time(VALUE self)
{
    SSL_SESSION *ctx;
    long t;

    GetSSLSession(self, ctx);
    t = SSL_SESSION_get_time(ctx);
    if (t == 0)
	return Qnil;

    return rb_funcall(rb_cTime, rb_intern("at"), 1, LONG2NUM(t));
}

#time=(time) ⇒ Object #time=(integer) ⇒ Object

Sets start time of the session. Time resolution is in seconds.



175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'ext/openssl/ossl_ssl_session.c', line 175

static VALUE ossl_ssl_session_set_time(VALUE self, VALUE time_v)
{
	SSL_SESSION *ctx;
	long t;

	GetSSLSession(self, ctx);
	if (rb_obj_is_instance_of(time_v, rb_cTime)) {
		time_v = rb_funcall(time_v, rb_intern("to_i"), 0);
	}
	t = NUM2LONG(time_v);
	SSL_SESSION_set_time(ctx, t);
	return ossl_ssl_session_get_time(self);
}

#timeout ⇒ Integer

Returns the timeout value set for the session, in seconds from the established time.

Returns:



155
156
157
158
159
160
161
162
163
164
165
 
# File 'ext/openssl/ossl_ssl_session.c', line 155

static VALUE
ossl_ssl_session_get_timeout(VALUE self)
{
    SSL_SESSION *ctx;
    long t;

    GetSSLSession(self, ctx);
    t = SSL_SESSION_get_timeout(ctx);

    return LONG2NUM(t);
}

#timeout=(integer) ⇒ Object

Sets how long until the session expires in seconds.



195
196
197
198
199
200
201
202
203
204
 
# File 'ext/openssl/ossl_ssl_session.c', line 195

static VALUE ossl_ssl_session_set_timeout(VALUE self, VALUE time_v)
{
	SSL_SESSION *ctx;
	long t;

	GetSSLSession(self, ctx);
	t = NUM2LONG(time_v);
	SSL_SESSION_set_timeout(ctx, t);
	return ossl_ssl_session_get_timeout(self);
}

#to_der ⇒ String

Returns an ASN1 encoded String that contains the Session object.

Returns:

  • (String) 


231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'ext/openssl/ossl_ssl_session.c', line 231

static VALUE ossl_ssl_session_to_der(VALUE self)
{
	SSL_SESSION *ctx;
	unsigned char *p;
	int len;
	VALUE str;

	GetSSLSession(self, ctx);
	len = i2d_SSL_SESSION(ctx, NULL);
	if (len <= 0) {
		ossl_raise(eSSLSession, "i2d_SSL_SESSION");
	}

	str = rb_str_new(0, len);
	p = (unsigned char *)RSTRING_PTR(str);
	i2d_SSL_SESSION(ctx, &p);
	ossl_str_adjust(str, p);
	return str;
}

#to_pem ⇒ String

Returns a PEM encoded String that contains the Session object.

Returns:

  • (String) 


257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'ext/openssl/ossl_ssl_session.c', line 257

static VALUE ossl_ssl_session_to_pem(VALUE self)
{
	SSL_SESSION *ctx;
	BIO *out;

	GetSSLSession(self, ctx);

	if (!(out = BIO_new(BIO_s_mem()))) {
		ossl_raise(eSSLSession, "BIO_s_mem()");
	}

	if (!PEM_write_bio_SSL_SESSION(out, ctx)) {
		BIO_free(out);
		ossl_raise(eSSLSession, "SSL_SESSION_print()");
	}


	return ossl_membio2str(out);
}

#to_text ⇒ String

Shows everything in the Session object. This is for diagnostic purposes.

Returns:

  • (String) 


284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'ext/openssl/ossl_ssl_session.c', line 284

static VALUE ossl_ssl_session_to_text(VALUE self)
{
	SSL_SESSION *ctx;
	BIO *out;

	GetSSLSession(self, ctx);

	if (!(out = BIO_new(BIO_s_mem()))) {
		ossl_raise(eSSLSession, "BIO_s_mem()");
	}

	if (!SSL_SESSION_print(out, ctx)) {
		BIO_free(out);
		ossl_raise(eSSLSession, "SSL_SESSION_print()");
	}

	return ossl_membio2str(out);
}