ttssh2/ttxssh/fwd.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 __FWD_H
#define __FWD_H

// �|�[�g�]�����������t���[���������l
// �K�p�� Channel_t.bufchain_amount
#define FWD_HIGH_WATER_MARK (1 * 1024 * 1024)  // 1MB
#define FWD_LOW_WATER_MARK (0)  // 0MB

#define FWD_REMOTE_CONNECTED  0x01
#define FWD_LOCAL_CONNECTED   0x02
#define FWD_BOTH_CONNECTED    (FWD_REMOTE_CONNECTED | FWD_LOCAL_CONNECTED)
#define FWD_CLOSED_REMOTE_IN  0x04
#define FWD_CLOSED_REMOTE_OUT 0x08
#define FWD_CLOSED_LOCAL_IN   0x10
#define FWD_CLOSED_LOCAL_OUT  0x20
#define FWD_AGENT_DUMMY       0x40

typedef enum {
        FWD_FILTER_REMOVE, FWD_FILTER_RETAIN, FWD_FILTER_CLOSECHANNEL
} FwdFilterResult;

typedef enum {
        FWD_FILTER_CLEANUP,
        FWD_FILTER_OPENCONFIRM,
        FWD_FILTER_OPENFAILURE,
        FWD_FILTER_FROM_CLIENT,
        FWD_FILTER_FROM_SERVER
} FwdFilterEvent;

/* a length == 0 means that we're killing the channel and the filter should deallocate */
typedef FwdFilterResult (* FWDFilter)(void *closure, FwdFilterEvent event, int *length, unsigned char **buf);

typedef struct {
  int status;
  int remote_num;
  SOCKET local_socket;
  int request_num;
  UTILSockWriteBuf writebuf;

  void *filter_closure;
  FWDFilter filter;
  struct addrinfo *to_host_addrs;

  // for agent forwarding
  buffer_t *agent_msg;
  int agent_request_len;
  enum channel_type type;
} FWDChannel;

/* Request types */
typedef enum {
        FWD_NONE,
        FWD_LOCAL_TO_REMOTE,
        FWD_LOCAL_DYNAMIC,
        FWD_LISTENING_LOCAL, // ���r�p���_�~�[�B���[�J���� listen ������������������������
        FWD_REMOTE_TO_LOCAL,
        FWD_REMOTE_X11_TO_LOCAL
} FWDType;

#define FwdTypeIsLocal(type)    ((type) > FWD_NONE && (type) < FWD_LISTENING_LOCAL)
#define FwdTypeIsRemote(type)   ((type) > FWD_LISTENING_LOCAL)
#define FwdListeningType(type)  (FwdTypeIsLocal(type)?FWD_LOCAL_TO_REMOTE:(type))

/* If 'type' is FWD_REMOTE_X11_TO_LOCAL, then from_port must be
   -1, to_port must be 6000 + display number, and to_host must
   be the desired X server host.

   There can be no more than one spec of a given type and from_port
   at one time.
*/
typedef struct {
  FWDType type;
  int from_port;
  char from_port_name[32];
  int to_port;
  char to_port_name[32];
  char to_host[256];
  char bind_address[256];
  int x11_screen;
} FWDRequestSpec;

#define FWD_DELETED                      0x01

#define MAX_LISTENING_SOCKETS 4096
typedef struct {
  int num_listening_sockets;
  SOCKET *listening_sockets;
  struct addrinfo *to_host_addrs;
  HANDLE to_host_lookup_handle;

  int num_channels;

  int status;
  FWDRequestSpec spec;
} FWDRequest;

typedef struct {
  HWND accept_wnd;
  WNDPROC old_accept_wnd_proc;
  int num_server_listening_specs;
  /* stored in sorted order */
  FWDRequestSpec *server_listening_specs;
  int num_requests;
  FWDRequest *requests;
  int num_channels;
  FWDChannel *channels;
  struct _X11AuthData *X11_auth_data;
  BOOL in_interactive_mode;
} FWDState;

void FWD_init(PTInstVar pvar);
BOOL FWD_can_server_listen_for(PTInstVar pvar, FWDRequestSpec *spec);
int FWD_get_num_request_specs(PTInstVar pvar);
void FWD_get_request_specs(PTInstVar pvar, FWDRequestSpec *specs, int num_specs);
void FWD_set_request_specs(PTInstVar pvar, FWDRequestSpec *specs, int num_specs);
int FWD_compare_specs(void const *void_spec1, void const *void_spec2);
void FWD_prep_forwarding(PTInstVar pvar);
void FWD_enter_interactive_mode(PTInstVar pvar);
void FWD_open(PTInstVar pvar, uint32 remote_channel_num,
              char *local_hostname, int local_port,
              char *originator, int originator_len,
              int *chan_num);
void FWD_X11_open(PTInstVar pvar, uint32 remote_channel_num,
                  char *originator, int originator_len,
                  int *chan_num);
void FWD_confirmed_open(PTInstVar pvar, uint32 local_channel_num,
  uint32 remote_channel_num);
void FWD_failed_open(PTInstVar pvar, uint32 local_channel_num, int reason);
void FWD_received_data(PTInstVar pvar, uint32 local_channel_num,
  unsigned char *data, int length);
void FWD_channel_input_eof(PTInstVar pvar, uint32 local_channel_num);
void FWD_channel_output_eof(PTInstVar pvar, uint32 local_channel_num);
void FWD_end(PTInstVar pvar);
void FWD_free_channel(PTInstVar pvar, uint32 local_channel_num);
int FWD_check_local_channel_num(PTInstVar pvar, int local_num);
int FWD_agent_open(PTInstVar pvar, uint32 remote_channel_num);
BOOL FWD_agent_forward_confirm(PTInstVar pvar);
void FWD_suspend_resume_local_connection(PTInstVar pvar, Channel_t* c, int notify);

#endif