Class: OpenSSL::SSL::Session

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

Defined Under Namespace

Classes: SessionError

Instance Method Summary collapse

Constructor Details

#new(SSLSocket|string) ⇒ Object

Parameters

SSLSocket is an OpenSSL::SSL::SSLSocket string must be a DER or PEM encoded Session.



36
37
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
71
72
73
74
75
# File 'ext/rubysl/openssl/ossl_ssl_session.c', line 36

static VALUE ossl_ssl_session_initialize(VALUE self, VALUE arg1)
{
	SSL_SESSION *ctx = NULL;
	VALUE obj;
	unsigned char *p;

	if (RDATA(self)->data)
		ossl_raise(eSSLSession, "SSL Session already initialized");

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

		Data_Get_Struct(arg1, SSL, ssl);

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

		ctx = PEM_read_bio_SSL_SESSION(in, NULL, NULL, NULL);

		if (!ctx) {
			BIO_reset(in);
			ctx = d2i_SSL_SESSION_bio(in, NULL);
		}

		BIO_free(in);

		if (!ctx)
			ossl_raise(rb_eArgError, "unknown type");
	}

	/* should not happen */
	if (ctx == NULL)
		ossl_raise(eSSLSession, "ctx not set - internal error");

	RDATA(self)->data = ctx;

	return self;
}

Instance Method Details

#==(session2) ⇒ Boolean

Returns:

  • (Boolean)


82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
# File 'ext/rubysl/openssl/ossl_ssl_session.c', line 82

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

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

	/*
	 * OpenSSL 1.0.0betas do not have non-static SSL_SESSION_cmp.
	 * ssl_session_cmp (was SSL_SESSION_cmp in 0.9.8) is for lhash
	 * comparing so we should not depend on it.  Just compare sessions
	 * by version and id.
	 */
	if ((ctx1->ssl_version == ctx2->ssl_version) &&
	    (ctx1->session_id_length == ctx2->session_id_length) &&
	    (memcmp(ctx1->session_id, ctx2->session_id, ctx1->session_id_length) == 0)) {
	    return Qtrue;
	} else {
	    return Qfalse;
	}
}

#idObject

#timeTime

Returns:

  • (Time)


109
110
111
112
113
114
115
116
117
118
119
120
121
122
# File 'ext/rubysl/openssl/ossl_ssl_session.c', line 109

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=Object

#timeoutInteger

How long until the session expires in seconds.

Returns:



131
132
133
134
135
136
137
138
139
140
141
# File 'ext/rubysl/openssl/ossl_ssl_session.c', line 131

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=Object

#to_deraString

Returns an ASN1 encoded String that contains the Session object.

Returns:

  • (aString)


196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
# File 'ext/rubysl/openssl/ossl_ssl_session.c', line 196

static VALUE ossl_ssl_session_to_der(VALUE self)
{
	SSL_SESSION *ctx;
	unsigned char buf[1024*10], *p;
	int len;

	GetSSLSession(self, ctx);

	p = buf;
	len = i2d_SSL_SESSION(ctx, &p);

	if (len <= 0)
		ossl_raise(eSSLSession, "i2d_SSL_SESSION");
	else if (len >= sizeof(buf))
		ossl_raise(eSSLSession, "i2d_SSL_SESSION too large");

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

#to_pemString

Returns a PEM encoded String that contains the Session object.

Returns:

  • (String)


221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
# File 'ext/rubysl/openssl/ossl_ssl_session.c', line 221

static VALUE ossl_ssl_session_to_pem(VALUE self)
{
	SSL_SESSION *ctx;
	BIO *out;
	BUF_MEM *buf;
	VALUE str;
	int i;
         
	GetSSLSession(self, ctx);

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

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

	BIO_get_mem_ptr(out, &buf);
	str = rb_str_new(buf->data, buf->length);
	BIO_free(out);

	return str;
}

#to_textString

Shows everything in the Session object.

Returns:

  • (String)


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

static VALUE ossl_ssl_session_to_text(VALUE self)
{
	SSL_SESSION *ctx;
	BIO *out;
	BUF_MEM *buf;
	VALUE str;
         
	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()");
	}

	BIO_get_mem_ptr(out, &buf);
	str = rb_str_new(buf->data, buf->length);
	BIO_free(out);

	return str;
}