OpenVPN
session_id.h
Go to the documentation of this file.
1 /*
2  * OpenVPN -- An application to securely tunnel IP networks
3  * over a single UDP port, with support for SSL/TLS-based
4  * session authentication and key exchange,
5  * packet encryption, packet authentication, and
6  * packet compression.
7  *
8  * Copyright (C) 2002-2018 OpenVPN Inc <sales@openvpn.net>
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License version 2
12  * as published by the Free Software Foundation.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License along
20  * with this program; if not, write to the Free Software Foundation, Inc.,
21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
22  */
23 
24 /*
25  * Each session is identified by a random 8-byte session identifier.
26  *
27  * For efficiency, the session id is only transmitted over the control
28  * channel (which only sees traffic occasionally when keys are being
29  * negotiated).
30  */
31 
32 #ifndef SESSION_ID_H
33 #define SESSION_ID_H
34 
35 #include "basic.h"
36 #include "buffer.h"
37 
38 struct session_id
39 {
40  uint8_t id[8];
41 };
42 
43 extern const struct session_id x_session_id_zero;
44 
45 #define SID_SIZE (sizeof(x_session_id_zero.id))
46 
47 static inline bool
48 session_id_equal(const struct session_id *sid1,
49  const struct session_id *sid2)
50 {
51  return !memcmp(sid1->id, sid2->id, SID_SIZE);
52 }
53 
54 static inline bool
55 session_id_defined(const struct session_id *sid1)
56 {
57  return memcmp(sid1->id, &x_session_id_zero.id, SID_SIZE) != 0;
58 }
59 
60 static inline bool
61 session_id_read(struct session_id *sid, struct buffer *buf)
62 {
63  return buf_read(buf, sid->id, SID_SIZE);
64 }
65 
66 static inline bool
67 session_id_write_prepend(const struct session_id *sid, struct buffer *buf)
68 {
69  return buf_write_prepend(buf, sid->id, SID_SIZE);
70 }
71 
72 static inline bool
73 session_id_write(const struct session_id *sid, struct buffer *buf)
74 {
75  return buf_write(buf, sid->id, SID_SIZE);
76 }
77 
78 void session_id_random(struct session_id *sid);
79 
80 const char *session_id_print(const struct session_id *sid, struct gc_arena *gc);
81 
82 #endif /* SESSION_ID_H */
static bool session_id_equal(const struct session_id *sid1, const struct session_id *sid2)
Definition: session_id.h:48
static bool session_id_write(const struct session_id *sid, struct buffer *buf)
Definition: session_id.h:73
#define SID_SIZE
Definition: session_id.h:45
static bool buf_read(struct buffer *src, void *dest, int size)
Definition: buffer.h:783
static bool buf_write(struct buffer *dest, const void *src, int size)
Definition: buffer.h:672
uint8_t id[8]
Definition: session_id.h:40
void session_id_random(struct session_id *sid)
Definition: session_id.c:51
const char * session_id_print(const struct session_id *sid, struct gc_arena *gc)
Definition: session_id.c:57
static bool session_id_defined(const struct session_id *sid1)
Definition: session_id.h:55
static bool session_id_read(struct session_id *sid, struct buffer *buf)
Definition: session_id.h:61
const struct session_id x_session_id_zero
Definition: session_id.c:48
unsigned __int8 uint8_t
Definition: config-msvc.h:123
Wrapper structure for dynamically allocated memory.
Definition: buffer.h:60
static bool buf_write_prepend(struct buffer *dest, const void *src, int size)
Definition: buffer.h:684
Garbage collection arena used to keep track of dynamically allocated memory.
Definition: buffer.h:116
static bool session_id_write_prepend(const struct session_id *sid, struct buffer *buf)
Definition: session_id.h:67