Dev/utvpn/utvpn-unix-v101-7101-public/src/Cedar/Protocol.h

   1 // SoftEther UT-VPN SourceCode\r
   2 // \r
   3 // Copyright (C) 2004-2010 SoftEther Corporation.\r
   4 // Copyright (C) 2004-2010 University of Tsukuba, Japan.\r
   5 // Copyright (C) 2003-2010 Daiyuu Nobori.\r
   6 // All Rights Reserved.\r
   7 // \r
   8 // http://utvpn.tsukuba.ac.jp/\r
   9 // \r
  10 // This program is free software; you can redistribute it and/or\r
  11 // modify it under the terms of the GNU General Public License\r
  12 // version 2 as published by the Free Software Foundation.\r
  13 // \r
  14 // This program is distributed in the hope that it will be useful,\r
  15 // but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  16 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\r
  17 // GNU General Public License for more details.\r
  18 // \r
  19 // You should have received a copy of the GNU General Public License version 2\r
  20 // along with this program; if not, write to the Free Software\r
  21 // Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.\r
  22 // \r
  23 // このファイルは GPL バージョン 2 ライセンスで公開されています。\r
  24 // 誰でもこのファイルの内容を複製、改変したり、改変したバージョンを再配布\r
  25 // することができます。ただし、原著作物を改変した場合は、原著作物の著作権表示\r
  26 // を除去することはできません。改変した著作物を配布する場合は、改変実施者の\r
  27 // 著作権表示を原著作物の著作権表示に付随して記載するようにしてください。\r
  28 // \r
  29 // この SoftEther UT-VPN オープンソース・プロジェクトは、日本国の\r
  30 // ソフトイーサ株式会社 (SoftEther Corporation, http://www.softether.co.jp/ )\r
  31 // および筑波大学 (University of Tsukuba, http://www.tsukuba.ac.jp/ ) によって\r
  32 // ホストされています。\r
  33 // 本プログラムの配布者は、本プログラムを、業としての利用以外のため、\r
  34 // および、試験または研究のために利用が行われることを想定して配布\r
  35 // しています。\r
  36 // SoftEther UT-VPN プロジェクトの Web サイトは http://utvpn.tsukuba.ac.jp/ に\r
  37 // あります。\r
  38 // 本ソフトウェアの不具合の修正、機能改良、セキュリティホールの修復などのコード\r
  39 // の改変を行った場合で、その成果物を SoftEther UT-VPN プロジェクトに提出して\r
  40 // いただける場合は、 http://utvpn.tsukuba.ac.jp/ までソースコードを送付して\r
  41 // ください。SoftEther UT-VPN プロジェクトの本体リリースまたはブランチリリース\r
  42 // に組み込みさせていただきます。\r
  43 // \r
  44 // GPL に基づいて原著作物が提供される本ソフトウェアの改良版を配布、販売する\r
  45 // 場合は、そのソースコードを GPL に基づいて誰にでも開示する義務が生じます。\r
  46 // \r
  47 // 本ソフトウェアに関連する著作権、特許権、商標権はソフトイーサ株式会社\r
  48 // (SoftEther Corporation) およびその他の著作権保持者が保有しています。\r
  49 // ソフトイーサ株式会社等はこれらの権利を放棄していません。本ソフトウェアの\r
  50 // 二次著作物を配布、販売する場合は、これらの権利を侵害しないようにご注意\r
  51 // ください。\r
  52 // \r
  53 // お願い: どのような通信ソフトウェアにも通常は必ず未発見の\r
  54 // セキュリティホールが潜んでいます。本ソースコードをご覧いただいた結果、\r
  55 // UT-VPN にセキュリティホールを発見された場合は、当該セキュリティホールの\r
  56 // 情報を不特定多数に開示される前に、必ず、ソフトイーサ株式会社\r
  57 // および脆弱性情報の届出を受け付ける公的機関まで通報いただき、\r
  58 // 公益保護にご協力いただきますようお願い申し上げます。\r
  59 // \r
  60 // ソフトイーサ株式会社は、当該セキュリティホールについて迅速に対処を\r
  61 // 行い、UT-VPN および UT-VPN に関連するソフトウェアのユーザー・顧客\r
  62 // を保護するための努力を行います。\r
  63 // \r
  64 // ソフトイーサへの届出先: http://www.softether.co.jp/jp/contact/\r
  65 // 日本国内の脆弱性情報届出受付公的機関:\r
  66 //         独立行政法人 情報処理推進機構\r
  67 //         http://www.ipa.go.jp/security/vuln/report/\r
  68 // \r
  69 // 上記各事項について不明な点は、ソフトイーサ株式会社までご連絡ください。\r
  70 // 連絡先: http://www.softether.co.jp/jp/contact/\r
  71 \r
  72 // -----------------------------------------------\r
  73 // [ChangeLog]\r
  74 // 2010.05.20\r
  75 //  新規リリース by SoftEther\r
  76 // -----------------------------------------------\r
  77 \r
  78 // Protocol.h\r
  79 // Protocol.c のヘッダ\r
  80 \r
  81 #ifndef PROTOCOL_H\r
  82 #define PROTOCOL_H\r
  83 \r
  84 // 証明書確認用スレッドに渡すパラメータ\r
  85 struct CHECK_CERT_THREAD_PROC\r
  86 {\r
  87         CONNECTION *Connection;\r
  88         X *ServerX;\r
  89         CHECK_CERT_PROC *CheckCertProc;\r
  90         bool UserSelected;\r
  91         bool Exipred;\r
  92         bool Ok;\r
  93 };\r
  94 \r
  95 // セキュアデバイス署名用スレッドに渡すパラメータ\r
  96 struct SECURE_SIGN_THREAD_PROC\r
  97 {\r
  98         SECURE_SIGN_PROC *SecureSignProc;\r
  99         CONNECTION *Connection;\r
 100         SECURE_SIGN *SecureSign;\r
 101         bool UserFinished;\r
 102         bool Ok;\r
 103 };\r
 104 \r
 105 // ランダムサイズキャッシュ\r
 106 struct RAND_CACHE\r
 107 {\r
 108         IP Ip;                                                  // IP アドレス\r
 109         UINT RandSize;                                  // ランダムサイズ\r
 110         UINT64 LastTime;                                // 最終使用日時\r
 111 };\r
 112 \r
 113 // HTTP 値\r
 114 struct HTTP_VALUE\r
 115 {\r
 116         char *Name;                                             // 名前\r
 117         char *Data;                                             // データ\r
 118 };\r
 119 \r
 120 // HTTP ヘッダ\r
 121 struct HTTP_HEADER\r
 122 {\r
 123         char *Method;                                   // メソッド\r
 124         char *Target;                                   // ターゲット\r
 125         char *Version;                                  // バージョン\r
 126         LIST *ValueList;                                // 値リスト\r
 127 };\r
 128 \r
 129 // シグネチャ送信スレッド用パラメータ\r
 130 struct SEND_SIGNATURE_PARAM\r
 131 {\r
 132         char Hostname[MAX_PATH];                // ホスト名\r
 133         UINT Port;                                              // ポート番号\r
 134         BUF *Buffer;                                    // パケット内容\r
 135 };\r
 136 \r
 137 \r
 138 // 関数プロトタイプ\r
 139 bool ServerAccept(CONNECTION *c);\r
 140 bool ClientConnect(CONNECTION *c);\r
 141 SOCK *ClientConnectToServer(CONNECTION *c);\r
 142 SOCK *TcpIpConnect(char *hostname, UINT port);\r
 143 SOCK *TcpIpConnectEx(char *hostname, UINT port, bool *cancel_flag, void *hWnd);\r
 144 bool ClientUploadSignature(SOCK *s);\r
 145 bool ClientDownloadHello(CONNECTION *c, SOCK *s);\r
 146 bool ServerDownloadSignature(CONNECTION *c);\r
 147 bool ServerUploadHello(CONNECTION *c);\r
 148 bool ClientUploadAuth(CONNECTION *c);\r
 149 SOCK *ClientConnectGetSocket(CONNECTION *c, bool additional_connect);\r
 150 SOCK *TcpConnectEx2(char *hostname, UINT port, UINT timeout, bool *cancel_flag, void *hWnd);\r
 151 \r
 152 void InitProtocol();\r
 153 void FreeProtocol();\r
 154 \r
 155 bool HttpServerSend(SOCK *s, PACK *p);\r
 156 PACK *HttpServerRecv(SOCK *s);\r
 157 PACK *HttpClientRecv(SOCK *s);\r
 158 bool HttpClientSend(SOCK *s, PACK *p);\r
 159 \r
 160 bool HttpSendForbidden(SOCK *s, char *target, char *server_id);\r
 161 bool HttpSendNotFound(SOCK *s, char *target);\r
 162 bool HttpSendNotImplemented(SOCK *s, char *method, char *target, char *version);\r
 163 \r
 164 char *RecvLine(SOCK *s, UINT max_size);\r
 165 HTTP_HEADER *RecvHttpHeader(SOCK *s);\r
 166 void FreeHttpHeader(HTTP_HEADER *header);\r
 167 void FreeHttpValue(HTTP_VALUE *value);\r
 168 HTTP_HEADER *NewHttpHeader(char *method, char *target, char *version);\r
 169 void AddHttpValue(HTTP_HEADER *header, HTTP_VALUE *value);\r
 170 int CompareHttpValue(void *p1, void *p2);\r
 171 HTTP_VALUE *GetHttpValue(HTTP_HEADER *header, char *name);\r
 172 HTTP_VALUE *NewHttpValue(char *name, char *data);\r
 173 char *HttpHeaderToStr(HTTP_HEADER *header);\r
 174 bool SendHttpHeader(SOCK *s, HTTP_HEADER *header);\r
 175 bool PostHttp(SOCK *s, HTTP_HEADER *header, void *post_data, UINT post_size);\r
 176 UINT GetContentLength(HTTP_HEADER *header);\r
 177 void GetHttpDateStr(char *str, UINT size, UINT64 t);\r
 178 void CreateDummyValue(PACK *p);\r
 179 \r
 180 X *PackGetX(PACK *p, char *name);\r
 181 K *PackGetK(PACK *p, char *name);\r
 182 void PackAddX(PACK *p, char *name, X *x);\r
 183 void PackAddK(PACK *p, char *name, K *k);\r
 184 void PackAddStr(PACK *p, char *name, char *str);\r
 185 void PackAddStrEx(PACK *p, char *name, char *str, UINT index, UINT total);\r
 186 void PackAddUniStr(PACK *p, char *name, wchar_t *unistr);\r
 187 void PackAddUniStrEx(PACK *p, char *name, wchar_t *unistr, UINT index, UINT total);\r
 188 void PackAddInt(PACK *p, char *name, UINT i);\r
 189 void PackAddNum(PACK *p, char *name, UINT num);\r
 190 void PackAddIntEx(PACK *p, char *name, UINT i, UINT index, UINT total);\r
 191 void PackAddInt64(PACK *p, char *name, UINT64 i);\r
 192 void PackAddInt64Ex(PACK *p, char *name, UINT64 i, UINT index, UINT total);\r
 193 void PackAddData(PACK *p, char *name, void *data, UINT size);\r
 194 void PackAddDataEx(PACK *p, char *name, void *data, UINT size, UINT index, UINT total);\r
 195 void PackAddBuf(PACK *p, char *name, BUF *b);\r
 196 void PackAddBufEx(PACK *p, char *name, BUF *b, UINT index, UINT total);\r
 197 bool PackGetStr(PACK *p, char *name, char *str, UINT size);\r
 198 bool PackGetStrEx(PACK *p, char *name, char *str, UINT size, UINT index);\r
 199 bool PackGetUniStr(PACK *p, char *name, wchar_t *unistr, UINT size);\r
 200 bool PackGetUniStrEx(PACK *p, char *name, wchar_t *unistr, UINT size, UINT index);\r
 201 UINT PackGetIndexCount(PACK *p, char *name);\r
 202 UINT PackGetInt(PACK *p, char *name);\r
 203 UINT PackGetNum(PACK *p, char *name);\r
 204 UINT PackGetIntEx(PACK *p, char *name, UINT index);\r
 205 UINT64 PackGetInt64(PACK *p, char *name);\r
 206 UINT64 PackGetInt64Ex(PACK *p, char *name, UINT index);\r
 207 UINT PackGetDataSizeEx(PACK *p, char *name, UINT index);\r
 208 UINT PackGetDataSize(PACK *p, char *name);\r
 209 bool PackGetData(PACK *p, char *name, void *data);\r
 210 bool PackGetDataEx(PACK *p, char *name, void *data, UINT index);\r
 211 BUF *PackGetBuf(PACK *p, char *name);\r
 212 BUF *PackGetBufEx(PACK *p, char *name, UINT index);\r
 213 POLICY *PackGetPolicy(PACK *p);\r
 214 void PackAddPolicy(PACK *p, POLICY *y);\r
 215 bool PackGetBool(PACK *p, char *name);\r
 216 void PackAddBool(PACK *p, char *name, bool b);\r
 217 void PackAddBoolEx(PACK *p, char *name, bool b, UINT index, UINT total);\r
 218 bool PackGetBoolEx(PACK *p, char *name, UINT index);\r
 219 void PackAddIp(PACK *p, char *name, IP *ip);\r
 220 void PackAddIpEx(PACK *p, char *name, IP *ip, UINT index, UINT total);\r
 221 bool PackGetIp(PACK *p, char *name, IP *ip);\r
 222 bool PackGetIpEx(PACK *p, char *name, IP *ip, UINT index);\r
 223 UINT PackGetIp32(PACK *p, char *name);\r
 224 UINT PackGetIp32Ex(PACK *p, char *name, UINT index);\r
 225 void PackAddIp32(PACK *p, char *name, UINT ip32);\r
 226 void PackAddIp32Ex(PACK *p, char *name, UINT ip32, UINT index, UINT total);\r
 227 void PackAddIp6AddrEx(PACK *p, char *name, IPV6_ADDR *addr, UINT index, UINT total);\r
 228 bool PackGetIp6AddrEx(PACK *p, char *name, IPV6_ADDR *addr, UINT index);\r
 229 void PackAddIp6Addr(PACK *p, char *name, IPV6_ADDR *addr);\r
 230 bool PackGetIp6Addr(PACK *p, char *name, IPV6_ADDR *addr);\r
 231 \r
 232 PACK *PackWelcome(SESSION *s);\r
 233 PACK *PackHello(void *random, UINT ver, UINT build, char *server_str);\r
 234 bool GetHello(PACK *p, void *random, UINT *ver, UINT *build, char *server_str, UINT server_str_size);\r
 235 PACK *PackLoginWithAnonymous(char *hubname, char *username);\r
 236 PACK *PackLoginWithPassword(char *hubname, char *username, void *secure_password);\r
 237 PACK *PackLoginWithPlainPassword(char *hubname, char *username, void *plain_password);\r
 238 PACK *PackLoginWithCert(char *hubname, char *username, X *x, void *sign, UINT sign_size);\r
 239 bool GetMethodFromPack(PACK *p, char *method, UINT size);\r
 240 bool GetHubnameAndUsernameFromPack(PACK *p, char *username, UINT username_size,\r
 241                                                                    char *hubname, UINT hubname_size);\r
 242 PACK *PackAdditionalConnect(UCHAR *session_key);\r
 243 UINT GetAuthTypeFromPack(PACK *p);\r
 244 UINT GetErrorFromPack(PACK *p);\r
 245 PACK *PackError(UINT error);\r
 246 UINT GetProtocolFromPack(PACK *p);\r
 247 bool ParseWelcomeFromPack(PACK *p, char *session_name, UINT session_name_size,\r
 248                                                   char *connection_name, UINT connection_name_size,\r
 249                                                   POLICY **policy);\r
 250 \r
 251 bool SendPack(SOCK *s, PACK *p);\r
 252 PACK *RecvPack(SOCK *s);\r
 253 \r
 254 bool ClientAdditionalConnect(CONNECTION *c, THREAD *t);\r
 255 SOCK *ClientAdditionalConnectToServer(CONNECTION *c);\r
 256 bool ClientUploadAuth2(CONNECTION *c, SOCK *s);\r
 257 bool GetSessionKeyFromPack(PACK *p, UCHAR *session_key, UINT *session_key_32);\r
 258 void GenerateRC4KeyPair(RC4_KEY_PAIR *k);\r
 259 \r
 260 SOCK *ProxyConnect(CONNECTION *c, char *proxy_host_name, UINT proxy_port,\r
 261                                    char *server_host_name, UINT server_port,\r
 262                                    char *username, char *password, bool additional_connect);\r
 263 SOCK *ProxyConnectEx(CONNECTION *c, char *proxy_host_name, UINT proxy_port,\r
 264                                          char *server_host_name, UINT server_port,\r
 265                                          char *username, char *password, bool additional_connect,\r
 266                                          bool *cancel_flag, void *hWnd);\r
 267 SOCK *SocksConnect(CONNECTION *c, char *proxy_host_name, UINT proxy_port,\r
 268                                    char *server_host_name, UINT server_port,\r
 269                                    char *username, bool additional_connect);\r
 270 SOCK *SocksConnectEx(CONNECTION *c, char *proxy_host_name, UINT proxy_port,\r
 271                                          char *server_host_name, UINT server_port,\r
 272                                          char *username, bool additional_connect,\r
 273                                          bool *cancel_flag, void *hWnd);\r
 274 bool SocksSendRequestPacket(CONNECTION *c, SOCK *s, UINT dest_port, IP *dest_ip, char *userid);\r
 275 bool SocksRecvResponsePacket(CONNECTION *c, SOCK *s);\r
 276 void CreateNodeInfo(NODE_INFO *info, CONNECTION *c);\r
 277 UINT SecureSign(SECURE_SIGN *sign, UINT device_id, char *pin);\r
 278 void ClientUploadNoop(CONNECTION *c);\r
 279 bool ClientCheckServerCert(CONNECTION *c, bool *expired);\r
 280 void ClientCheckServerCertThread(THREAD *thread, void *param);\r
 281 bool ClientSecureSign(CONNECTION *c, UCHAR *sign, UCHAR *random, X **x);\r
 282 void ClientSecureSignThread(THREAD *thread, void *param);\r
 283 UINT SecureWrite(UINT device_id, char *cert_name, X *x, char *key_name, K *k, char *pin);\r
 284 UINT SecureEnum(UINT device_id, char *pin, TOKEN_LIST **cert_list, TOKEN_LIST **key_list);\r
 285 UINT SecureDelete(UINT device_id, char *pin, char *cert_name, char *key_name);\r
 286 bool PackGetData2(PACK *p, char *name, void *data, UINT size);\r
 287 bool PackGetDataEx2(PACK *p, char *name, void *data, UINT size, UINT index);\r
 288 TOKEN_LIST *EnumHub(SESSION *s);\r
 289 UINT ChangePasswordAccept(CONNECTION *c, PACK *p);\r
 290 UINT ChangePassword(CEDAR *cedar, CLIENT_OPTION *o, char *hubname, char *username, char *old_pass, char *new_pass);\r
 291 void PackAddClientVersion(PACK *p, CONNECTION *c);\r
 292 void NodeInfoToStr(wchar_t *str, UINT size, NODE_INFO *info);\r
 293 void GenerateMachineUniqueHash(void *data);\r
 294 void SendSignatureByUdp(CONNECTION *c, IP *ip);\r
 295 void SendSignatureByTcp(CONNECTION *c, IP *ip);\r
 296 void SendSignatureByTcpThread(THREAD *thread, void *param);\r
 297 \r
 298 \r
 299 #endif  // PROTOCOL_H\r