ttssh2/ttxssh/ttxssh.h

/*
 * Copyright (c) 1998-2001, Robert O'Callahan
 * (C) 2004- TeraTerm Project
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/*
This code is copyright (C) 1998-1999 Robert O'Callahan.
See LICENSE.TXT for the license.
*/

#ifndef __TTXSSH_H
#define __TTXSSH_H

#pragma warning(3 : 4035)

/* VS2015(VC14.0)�����AWSASocketA(), inet_ntoa() ������API��deprecated��������
* �x�������������A�x�����}�~�����B�����������u���������AVS2005(VC8.0)���r���h
* �����������������A�x�����}�~���������������B
*/
#if _MSC_VER >= 1800  // VSC2013(VC12.0) or later
        #ifndef _WINSOCK_DEPRECATED_NO_WARNINGS
                #define _WINSOCK_DEPRECATED_NO_WARNINGS
        #endif
#endif

#include <winsock2.h>
#include <ws2tcpip.h>
#include <wspiapi.h>
/* actual body of in6addr_any and in6addr_loopback is disappeared?? */
#undef IN6_IS_ADDR_LOOPBACK
#define IN6_IS_ADDR_LOOPBACK(a)         \
        ((*(unsigned int *)(&(a)->s6_addr[0]) == 0) &&     \
         (*(unsigned int *)(&(a)->s6_addr[4]) == 0) &&     \
         (*(unsigned int *)(&(a)->s6_addr[8]) == 0) &&     \
         (*(unsigned int *)(&(a)->s6_addr[12]) == ntohl(1)))
/* work around for MS Platform SDK Oct 2000 */
#include <malloc.h> /* prevent of conflict stdlib.h */
#include <stdlib.h>
#include <stdarg.h>
#include <crtdbg.h>

#include "i18n.h"
#include "ttlib.h"

typedef struct _TInstVar *PTInstVar;

#include "ttxssh-version.h"
#include "util.h"
#include "pkt.h"
#include "ssh.h"
#include "auth.h"
#include "crypt.h"
#include "cipher.h"
#include "comp.h"
#include "kex.h"
#include "hostkey.h"
#include "key.h"
#include "hosts.h"
#include "fwd.h"

#include <openssl/dh.h>
#include <openssl/ec.h>
#include <openssl/evp.h>
#include "buffer.h"

/* tttypes.h �����`���������� EM �}�N���� openssl/rsa.h (OpenSSL 0.9.8)�������v���g�^�C�v������
 * �������������d�����������������A�r���h�G���[�������B���L3�w�b�_��include���u�����L�����������B
 * (2005.7.9 yutaka)
 */
#include "teraterm.h"
#include "tttypes.h"
#include "ttplugin.h"

#if defined(_MSC_VER) && !defined(_Printf_format_string_)
// ���`�������������������������������������`��������
#define _Printf_format_string_
#endif

extern HANDLE hInst; /* Instance handle of TTXSSH.DLL */

#define ID_SSHSCPMENU       52110
#define ID_SSHSETUPMENU     52310
#define ID_SSHAUTHSETUPMENU 52320
#define ID_SSHFWDSETUPMENU  52330
#define ID_SSHKEYGENMENU    52340
#define ID_ABOUTMENU        52910

#define ID_SSHAUTH            62501
#define ID_SSHUNKNOWNHOST     62502
#define ID_SSHDIFFERENTKEY    62503
#define ID_SSHASYNCMESSAGEBOX 62504
#define ID_SSHDIFFERENT_TYPE_KEY 62505

#define OPTION_NONE     0
#define OPTION_CLEAR    1
#define OPTION_REPLACE  2

/*
 * DisablePopupMessage �p���r�b�g���`
 */
#define POPUP_MSG_default                       0
#define POPUP_MSG_FWD_received_data     (1 << 0)
#define POPUP_MSG_FWD_channel_open      (1 << 1)


/*
 * Host key rotation
 */
#define SSH_UPDATE_HOSTKEYS_NO  0
#define SSH_UPDATE_HOSTKEYS_YES 1
#define SSH_UPDATE_HOSTKEYS_ASK 2
#define SSH_UPDATE_HOSTKEYS_MAX 3

/*
 * Server compatibility flag
 */
#define SSH_BUG_DHGEX_LARGE 0x00000001


/*
These are the fields that WOULD go in Tera Term's 'ts' structure, if
we could put them there.
*/
typedef struct _TS_SSH {
        BOOL Enabled;
        int CompressionLevel; /* 0 = NONE, else 1-9 */

        int DefaultUserType;    /* 0/1/2 = no input/DefaultUserName/Windows logon user */
        char DefaultUserName[256];

        /* this next option is a string of digits. Each digit represents a
           cipher. The first digit is the most preferred cipher, and so on.
           The digit SSH_CIPHER_NONE signifies that any ciphers after it are
           disabled. */
        char CipherOrder[SSH_CIPHER_MAX+2];

        char KnownHostsFiles[2048];
        int DefaultAuthMethod;
        char DefaultRhostsLocalUserName[256];
        char DefaultRhostsHostPrivateKeyFile[1024];
        char DefaultRSAPrivateKeyFile[1024];

        char DefaultForwarding[4096];
        BOOL TryDefaultAuth;

        int LogLevel;      /* 0 = NONE, 100 = Verbose */
        int WriteBufferSize;

        int ssh_protocol_version; // SSH version (2004.10.11 yutaka)
        int ssh_heartbeat_overtime; // SSH heartbeat(keepalive) (2004.12.11 yutaka)
        // whether password will permanently store on heap memory (2006.8.5 yutaka)
        int remember_password;

        // try auth with "none" method for disable unsupported on dialog (2007.9.24 maya)
        BOOL CheckAuthListFirst;

        // Enable connection to the server that has RSA key length less than 768 bit (2008.9.11 maya)
        BOOL EnableRsaShortKeyServer;

        // Enable Agent forwarding
        BOOL ForwardAgent;

        // Confirm Agent forwarding
        BOOL ForwardAgentConfirm;

        // Confirm Agent forwarding
        BOOL ForwardAgentNotify;

        // KEX order(derived from teraterm.ini)
        char KexOrder[KEX_DH_MAX+1];
        char HostKeyOrder[KEY_ALGO_MAX+1];
        char MacOrder[HMAC_MAX+1];
        char CompOrder[COMP_MAX+1];

        BOOL VerifyHostKeyDNS;

        int IconID;

        int DisablePopupMessage;

        char X11Display[128];

        int UpdateHostkeys;

        int GexMinimalGroupSize;

        int AuthBanner;

        BOOL KexKeyLogging;
        wchar_t KexKeyLogFile[1024];

        // Sign algorithm order
        //   for publickey authentication (not for server hostkey)
        //   for RSA key only
        char RSAPubkeySignAlgorithmOrder[RSA_PUBKEY_SIGN_ALGO_MAX+1];
} TS_SSH;

typedef struct _TInstVar {
        PTTSet ts;
        PComVar cv;

        /* shared memory for settings across instances. Basically it's
           a cache for the INI file.*/
        TS_SSH *ts_SSH;

        int fatal_error;
        int showing_err;
        char *err_msg;

        Tconnect Pconnect;
        Trecv Precv;
        Tsend Psend;
        TWSAAsyncSelect PWSAAsyncSelect;
        TWSAGetLastError PWSAGetLastError;

        PReadIniFile ReadIniFile;
        PWriteIniFile WriteIniFile;
        PParseParam ParseParam;

        HMENU FileMenu;

        SOCKET socket;
        HWND NotificationWindow;
        unsigned int notification_msg;
        long notification_events;
        HICON OldSmallIcon; // �g�p������
        HICON OldLargeIcon; // �g�p������

        BOOL hostdlg_activated;
        BOOL hostdlg_Enabled;

        int protocol_major;
        int protocol_minor;

        PKTState pkt_state;
        SSHState ssh_state;
        AUTHState auth_state;
        CRYPTState crypt_state;
        HOSTSState hosts_state;
        FWDState fwd_state;

/* The settings applied to the current session. The user may change
   the settings but usually we don't want that to affect the session
   in progress (race conditions). So user setup changes usually
   modify the 'settings' field below. */
        TS_SSH session_settings;

/* our copy of the global settings. This is synced up with the shared
   memory only when we do a ReadIniFile or WriteIniFile
   (i.e. the user loads or saves setup) */
        TS_SSH settings;

        // SSH2
        DH *kexdh;
        char server_version_string[128];
        char client_version_string[128];
        buffer_t *my_kex;
        buffer_t *peer_kex;
        kex_algorithm kex_type; // KEX algorithm
        ssh_keyalgo hostkey_type;
        const struct ssh2cipher *ciphers[MODE_MAX];
        const struct SSH2Mac *macs[MODE_MAX];
        compression_type ctos_compression;
        compression_type stoc_compression;
        int we_need;
        int kex_status;
        char *session_id;
        int session_id_len;
        SSHKeys ssh2_keys[MODE_MAX];
        struct sshcipher_ctx *cc[MODE_MAX];
        int userauth_success;
        int shell_id;
        int session_nego_status;
        /*
        unsigned int local_window;
        unsigned int local_window_max;
        unsigned int local_consumed;
        unsigned int local_maxpacket;
        unsigned int remote_window;
        unsigned int remote_maxpacket;
        */
        int client_key_bits;
        int server_key_bits;
        int kexgex_min;
        int kexgex_bits;
        int kexgex_max;
        int ssh2_autologin;
        int ask4passwd;
        SSHAuthMethod ssh2_authmethod;
        char ssh2_username[MAX_PATH];
        char ssh2_password[MAX_PATH];
        char ssh2_keyfile[MAX_PATH];
        time_t ssh_heartbeat_tick;
        HANDLE ssh_heartbeat_thread;
        int keyboard_interactive_password_input;
        int userauth_retry_count;
        buffer_t *decomp_buffer;
        buffer_t *authbanner_buffer;
        char *ssh2_authlist;
        BOOL tryed_ssh2_authlist;
        HWND ssh_hearbeat_dialog;

        /* Pageant �������M�p */
        unsigned char *pageant_key;
        unsigned char *pageant_curkey;
        int pageant_keylistlen;
        int pageant_keycount;
        int pageant_keycurrent;
        BOOL pageant_keyfinal;// SSH2 PK_OK ������������ TRUE ������

        // agent forward
        BOOL agentfwd_enable;

        BOOL origDisableTCPEchoCR;

        BOOL nocheck_known_hosts;

        EC_KEY *ecdh_client_key;

        int dns_key_check;

        unsigned int server_compat_flag;

        void *hostkey_ctx;

        BOOL use_subsystem;
        char subsystem_name[256];

        BOOL nosession;

        // dialog resource
        HFONT hFontFixed;               // hosts.c�����_�C�A���O�p

        struct {
                BOOL suspended;  // SCP���M���t���[�����p,TRUE������������������������
                //BOOL timer_triggerd;
                UINT_PTR timer_id;
                BOOL data_finished;     // TRUE������,�f�[�^�����M����������
                BOOL close_request;
        } recv;

        char *server_sig_algs;

        char UIMsg[MAX_UIMSG];
} TInstVar;

// �o�[�W���������������������X�������B ��: TTSSH_2-81_TS_data
#define TTSSH_FILEMAPNAME "TTSSH_" TTSSH_VERSION_STR("-") "_TS_data"

#define LOG_LEVEL_FATAL      5
#define LOG_LEVEL_ERROR      10
#define LOG_LEVEL_WARNING    30
#define LOG_LEVEL_NOTICE     50
#define LOG_LEVEL_INFO       80
#define LOG_LEVEL_VERBOSE    100
#define LOG_LEVEL_SSHDUMP    200

#define SSHv1(pvar) ((pvar)->protocol_major == 1)
#define SSHv2(pvar) ((pvar)->protocol_major == 2)

#define LogLevel(pvar, level) ((pvar)->settings.LogLevel >= (level))

void notify_established_secure_connection(PTInstVar pvar);
void notify_closed_connection(PTInstVar pvar, char *send_msg);
void notify_nonfatal_error(PTInstVar pvar, char *msg);
void notify_fatal_error(PTInstVar pvar, char *msg, BOOL send_disconnect);
void logputs(int level, char *msg);
#if defined(_MSC_VER)
void logprintf(int level, _Printf_format_string_ const char *fmt, ...);
void logprintf_hexdump(int level, const char *data, int len, _Printf_format_string_ const char *fmt, ...);
#elif defined(__GNUC__)
void logprintf(int level, const char *fmt, ...) __attribute__ ((format (printf, 2, 3)));
void logprintf_hexdump(int level, const char *data, int len, const char *fmt, ...) __attribute__ ((format (printf, 4, 5)));
#else
void logprintf(int level, const char *fmt, ...);
void logprintf_hexdump(int level, const char *data, int len, const char *fmt, ...);
#endif

void get_teraterm_dir_relative_name(char *buf, int bufsize, char *basename);
wchar_t *get_teraterm_dir_relative_nameW(const wchar_t *basename);
int copy_teraterm_dir_relative_path(char *dest, int destsize, char *basename);
wchar_t *get_home_dir_relative_nameW(const wchar_t *basename);
wchar_t *get_log_dir_relative_nameW(const wchar_t *basename);
int uuencode(unsigned char *src, int srclen, unsigned char *target, int targsize);

#endif