src/openvpn/session_id.h
6fbf66fa
 /*
  *  OpenVPN -- An application to securely tunnel IP networks
  *             over a single UDP port, with support for SSL/TLS-based
  *             session authentication and key exchange,
  *             packet encryption, packet authentication, and
  *             packet compression.
  *
49979459
  *  Copyright (C) 2002-2018 OpenVPN Inc <sales@openvpn.net>
6fbf66fa
  *
  *  This program is free software; you can redistribute it and/or modify
  *  it under the terms of the GNU General Public License version 2
  *  as published by the Free Software Foundation.
  *
  *  This program is distributed in the hope that it will be useful,
  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  *  GNU General Public License for more details.
  *
caa54ac3
  *  You should have received a copy of the GNU General Public License along
  *  with this program; if not, write to the Free Software Foundation, Inc.,
  *  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
6fbf66fa
  */
 
 /*
  * Each session is identified by a random 8-byte session identifier.
  *
  * For efficiency, the session id is only transmitted over the control
  * channel (which only sees traffic occasionally when keys are being
  * negotiated).
  */
 
 #ifndef SESSION_ID_H
 #define SESSION_ID_H
 
 #include "basic.h"
 #include "buffer.h"
 
 struct session_id
 {
81d882d5
     uint8_t id[8];
6fbf66fa
 };
 
 extern const struct session_id x_session_id_zero;
 
81d882d5
 #define SID_SIZE (sizeof(x_session_id_zero.id))
6fbf66fa
 
 static inline bool
81d882d5
 session_id_equal(const struct session_id *sid1,
                  const struct session_id *sid2)
6fbf66fa
 {
81d882d5
     return !memcmp(sid1->id, sid2->id, SID_SIZE);
6fbf66fa
 }
 
 static inline bool
81d882d5
 session_id_defined(const struct session_id *sid1)
6fbf66fa
 {
81d882d5
     return memcmp(sid1->id, &x_session_id_zero.id, SID_SIZE) != 0;
6fbf66fa
 }
 
 static inline bool
81d882d5
 session_id_read(struct session_id *sid, struct buffer *buf)
6fbf66fa
 {
81d882d5
     return buf_read(buf, sid->id, SID_SIZE);
6fbf66fa
 }
 
 static inline bool
81d882d5
 session_id_write_prepend(const struct session_id *sid, struct buffer *buf)
6fbf66fa
 {
81d882d5
     return buf_write_prepend(buf, sid->id, SID_SIZE);
6fbf66fa
 }
 
 static inline bool
81d882d5
 session_id_write(const struct session_id *sid, struct buffer *buf)
6fbf66fa
 {
81d882d5
     return buf_write(buf, sid->id, SID_SIZE);
6fbf66fa
 }
 
81d882d5
 void session_id_random(struct session_id *sid);
6fbf66fa
 
81d882d5
 const char *session_id_print(const struct session_id *sid, struct gc_arena *gc);
6fbf66fa
 
 #endif /* SESSION_ID_H */