Initial commit.
[BoarSSL] / SSLTLS / ISessionCache.cs
1 /*
2 * Copyright (c) 2017 Thomas Pornin <pornin@bolet.org>
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining
5 * a copy of this software and associated documentation files (the
6 * "Software"), to deal in the Software without restriction, including
7 * without limitation the rights to use, copy, modify, merge, publish,
8 * distribute, sublicense, and/or sell copies of the Software, and to
9 * permit persons to whom the Software is furnished to do so, subject to
10 * the following conditions:
11 *
12 * The above copyright notice and this permission notice shall be
13 * included in all copies or substantial portions of the Software.
14 *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
16 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
17 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
18 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
19 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
20 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
21 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22 * SOFTWARE.
23 */
24
25 using System;
26 using System.IO;
27
28 namespace SSLTLS {
29
30 /*
31 * A session cache instance is able to cache and remember session
32 * parameters; this is typically used on a SSL server.
33 */
34
35 public interface ISessionCache {
36
37 /*
38 * Retrieve session parameters by session ID. If the client sent
39 * an intended server name (SNI extension), then that name is
40 * also provided as parameter (printable ASCII, normalised to
41 * lowercase, no space); otherwise, that parameter is null.
42 * Session cache implementations are free to use the server name
43 * or not; if the client specified a target name, and the cache
44 * returns parameters with a different, non-null name, then the
45 * session resumption will be rejected by the engine.
46 *
47 * If no parameters are found for that ID (and optional server
48 * name), then this method shall return null.
49 */
50 SSLSessionParameters Retrieve(byte[] id, string serverName);
51
52 /*
53 * Record new session parameters. These should be internally
54 * indexed by their ID.
55 */
56 void Store(SSLSessionParameters sp);
57 }
58
59 }