src/client.h

   1 /* Copyright (C) 2009-2014, Martin Johansson <martin@fatbob.nu>
   2    Copyright (C) 2005-2014, Thorvald Natvig <thorvald@natvig.com>
   3
   4    All rights reserved.
   5
   6    Redistribution and use in source and binary forms, with or without
   7    modification, are permitted provided that the following conditions
   8    are met:
   9
  10    - Redistributions of source code must retain the above copyright notice,
  11      this list of conditions and the following disclaimer.
  12    - Redistributions in binary form must reproduce the above copyright notice,
  13      this list of conditions and the following disclaimer in the documentation
  14      and/or other materials provided with the distribution.
  15    - Neither the name of the Developers nor the names of its contributors may
  16      be used to endorse or promote products derived from this software without
  17      specific prior written permission.
  18
  19    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  22    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
  23    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  24    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  25    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  26    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  27    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  28    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  29    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30 */
  31 #ifndef CLIENT_H_45786678
  32 #define CLIENT_H_45786678
  33
  34 #include "config.h"
  35 #include <stdint.h>
  36 #include <unistd.h>             /* close() */
  37 #include <sys/types.h>
  38 #include <sys/socket.h>         /* socket() */
  39 #include <netinet/in.h>         /* IPPROTO_TCP */
  40 #include <arpa/inet.h>          /* inet_addr() */
  41 #include <errno.h>              /* errno */
  42 #include <sys/poll.h>
  43
  44 #include "list.h"
  45 #include "types.h"
  46 #include "messages.h"
  47 #include "crypt.h"
  48 #include "timer.h"
  49 #include "pds.h"
  50 #include "ssl.h"
  51
  52 #define BUFSIZE 8192
  53 #define UDP_BUFSIZE 512
  54 #define INACTIVITY_TIMEOUT 15 /* Seconds */
  55 #define MAX_CODECS 10
  56 #define MAX_TOKENSIZE 64
  57 #define MAX_TOKENS 32
  58 #define KEY_LENGTH sizeof(uint16_t) + 4 * sizeof(in_addr_t)
  59
  60 #define IS_AUTH(_a_) ((_a_)->authenticated)
  61
  62 struct channel;
  63
  64 typedef struct {
  65         int tcpfd;
  66         SSL_handle_t *ssl;
  67         bool_t SSLready;
  68         bool_t shutdown_wait;
  69         cryptState_t cryptState;
  70         bool_t readBlockedOnWrite, writeBlockedOnRead;
  71         struct sockaddr_storage remote_tcp;
  72         struct sockaddr_storage remote_udp;
  73         uint8_t rxbuf[BUFSIZE], txbuf[BUFSIZE];
  74         uint32_t rxcount, msgsize, drainleft, txcount, txsize;
  75         int sessionId;
  76         uint8_t key[KEY_LENGTH];
  77         char *username;
  78         bool_t bUDP, authenticated, deaf, mute, self_deaf, self_mute, recording, bOpus;
  79         char *os, *release, *os_version;
  80         uint32_t version;
  81         int codec_count;
  82         struct dlist codecs;
  83         int availableBandwidth;
  84         etimer_t lastActivity, connectTime, idleTime;
  85         struct dlist node;
  86         struct dlist txMsgQueue;
  87         int txQueueCount;
  88         struct channel *channel;
  89         char *context;
  90         struct dlist chan_node;
  91         struct dlist voicetargets;
  92         struct dlist tokens;
  93         int tokencount;
  94         uint8_t hash[20];
  95         bool_t isAdmin;
  96         bool_t isSuppressed;
  97         float UDPPingAvg, UDPPingVar, TCPPingAvg, TCPPingVar;
  98         uint32_t UDPPackets, TCPPackets;
  99 } client_t;
 100
 101 typedef struct {
 102         int codec, count;
 103         struct dlist node;
 104 } codec_t;
 105
 106 typedef struct {
 107         char *token;
 108         struct dlist node;
 109 } token_t;
 110
 111 void Client_init();
 112 int Client_getfds(struct pollfd *pollfds);
 113 void Client_janitor();
 114 int Client_add(int fd, struct sockaddr_storage *remote);
 115 int Client_read_fd(int fd);
 116 int Client_write_fd(int fd);
 117 int Client_send_message(client_t *client, message_t *msg);
 118 int Client_send_message_ver(client_t *client, message_t *msg, uint32_t version);
 119 int Client_send_message_except_ver(client_t *client, message_t *msg, uint32_t version);
 120 int Client_count(void);
 121 void Client_close(client_t *client);
 122 client_t *Client_iterate(client_t **client);
 123 int Client_send_message_except(client_t *client, message_t *msg);
 124 int Client_read_udp(int udpsock);
 125 void Client_disconnect_all();
 126 int Client_voiceMsg(client_t *client, uint8_t *data, int len);
 127 void recheckCodecVersions(client_t *connectingClient);
 128 void Client_codec_add(client_t *client, int codec);
 129 void Client_codec_free(client_t *client);
 130 codec_t *Client_codec_iterate(client_t *client, codec_t **codec_itr);
 131 void Client_textmessage(client_t *client, char *text);
 132 bool_t Client_token_match(client_t *client, char const *str);
 133 void Client_token_free(client_t *client);
 134 void Client_token_add(client_t *client, char *token_string);
 135
 136 #endif