libssh: /build/libssh/src/libssh-0.8.2/include/libssh/session.h Source File

libssh 0.8.2 The SSH library

session.h
1 /*
2 * This file is part of the SSH Library
3 *
4 * Copyright (c) 2009 by Aris Adamantiadis
5 *
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
10 *
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 */
20
21 #ifndef SESSION_H_
22 #define SESSION_H_
23 #include "libssh/priv.h"
24 #include "libssh/kex.h"
25 #include "libssh/packet.h"
26 #include "libssh/pcap.h"
27 #include "libssh/auth.h"
28 #include "libssh/channels.h"
29 #include "libssh/poll.h"
30
31 /* These are the different states a SSH session can be into its life */
32 enum ssh_session_state_e {
33 SSH_SESSION_STATE_NONE=0,
34 SSH_SESSION_STATE_CONNECTING,
35 SSH_SESSION_STATE_SOCKET_CONNECTED,
36 SSH_SESSION_STATE_BANNER_RECEIVED,
37 SSH_SESSION_STATE_INITIAL_KEX,
38 SSH_SESSION_STATE_KEXINIT_RECEIVED,
39 SSH_SESSION_STATE_DH,
40 SSH_SESSION_STATE_AUTHENTICATING,
41 SSH_SESSION_STATE_AUTHENTICATED,
42 SSH_SESSION_STATE_ERROR,
43 SSH_SESSION_STATE_DISCONNECTED
44 };
45
46 enum ssh_dh_state_e {
47 DH_STATE_INIT=0,
48 DH_STATE_INIT_SENT,
49 DH_STATE_NEWKEYS_SENT,
50 DH_STATE_FINISHED
51 };
52
53 enum ssh_pending_call_e {
54 SSH_PENDING_CALL_NONE = 0,
55 SSH_PENDING_CALL_CONNECT,
56 SSH_PENDING_CALL_AUTH_NONE,
57 SSH_PENDING_CALL_AUTH_PASSWORD,
58 SSH_PENDING_CALL_AUTH_OFFER_PUBKEY,
59 SSH_PENDING_CALL_AUTH_PUBKEY,
60 SSH_PENDING_CALL_AUTH_AGENT,
61 SSH_PENDING_CALL_AUTH_KBDINT_INIT,
62 SSH_PENDING_CALL_AUTH_KBDINT_SEND,
63 SSH_PENDING_CALL_AUTH_GSSAPI_MIC
64 };
65
66 /* libssh calls may block an undefined amount of time */
67 #define SSH_SESSION_FLAG_BLOCKING 1
68
69 /* Client successfully authenticated */
70 #define SSH_SESSION_FLAG_AUTHENTICATED 2
71
72 /* codes to use with ssh_handle_packets*() */
73 /* Infinite timeout */
74 #define SSH_TIMEOUT_INFINITE -1
75 /* Use the timeout defined by user if any. Mostly used with new connections */
76 #define SSH_TIMEOUT_USER -2
77 /* Use the default timeout, depending on ssh_is_blocking() */
78 #define SSH_TIMEOUT_DEFAULT -3
79 /* Don't block at all */
80 #define SSH_TIMEOUT_NONBLOCKING 0
81
82 /* options flags */
83 /* Authentication with *** allowed */
84 #define SSH_OPT_FLAG_PASSWORD_AUTH 0x1
85 #define SSH_OPT_FLAG_PUBKEY_AUTH 0x2
86 #define SSH_OPT_FLAG_KBDINT_AUTH 0x4
87 #define SSH_OPT_FLAG_GSSAPI_AUTH 0x8
88
89 /* members that are common to ssh_session and ssh_bind */
90 struct ssh_common_struct {
91 struct error_struct error;
92 ssh_callbacks callbacks; /* Callbacks to user functions */
93 int log_verbosity; /* verbosity of the log functions */
94 };
95
96 struct ssh_session_struct {
97 struct ssh_common_struct common;
98 struct ssh_socket_struct *socket;
99 char *serverbanner;
100 char *clientbanner;
101 int protoversion;
102 int server;
103 int client;
104 int openssh;
105 uint32_t send_seq;
106 uint32_t recv_seq;
107
108 int connected;
109 /* !=0 when the user got a session handle */
110 int alive;
111 /* two previous are deprecated */
112 /* int auth_service_asked; */
113
114 /* session flags (SSH_SESSION_FLAG_*) */
115 int flags;
116
117 ssh_string banner; /* that's the issue banner from
118 the server */
119 char *discon_msg; /* disconnect message from
120 the remote host */
121 ssh_buffer in_buffer;
122 PACKET in_packet;
123 ssh_buffer out_buffer;
124
125 /* the states are used by the nonblocking stuff to remember */
126 /* where it was before being interrupted */
127 enum ssh_pending_call_e pending_call_state;
128 enum ssh_session_state_e session_state;
129 int packet_state;
130 enum ssh_dh_state_e dh_handshake_state;
131 enum ssh_channel_request_state_e global_req_state;
132 struct ssh_agent_state_struct *agent_state;
133
134 struct {
135 struct ssh_auth_auto_state_struct *auto_state;
136 enum ssh_auth_service_state_e service_state;
137 enum ssh_auth_state_e state;
138 uint32_t supported_methods;
139 uint32_t current_method;
140 } auth;
141
142 /*
143 * RFC 4253, 7.1: if the first_kex_packet_follows flag was set in
144 * the received SSH_MSG_KEXINIT, but the guess was wrong, this
145 * field will be set such that the following guessed packet will
146 * be ignored. Once that packet has been received and ignored,
147 * this field is cleared.
148 */
149 int first_kex_follows_guess_wrong;
150
151 ssh_buffer in_hashbuf;
152 ssh_buffer out_hashbuf;
153 struct ssh_crypto_struct *current_crypto;
154 struct ssh_crypto_struct *next_crypto; /* next_crypto is going to be used after a SSH2_MSG_NEWKEYS */
155
156 struct ssh_list *channels; /* linked list of channels */
157 int maxchannel;
158 int exec_channel_opened; /* version 1 only. more
159 info in channels1.c */
160 ssh_agent agent; /* ssh agent */
161
162 /* keyb interactive data */
163 struct ssh_kbdint_struct *kbdint;
164 struct ssh_gssapi_struct *gssapi;
165
166 /* server host keys */
167 struct {
168 ssh_key rsa_key;
169 ssh_key dsa_key;
170 ssh_key ecdsa_key;
171 ssh_key ed25519_key;
172 /* The type of host key wanted by client */
173 enum ssh_keytypes_e hostkey;
174 } srv;
175
176 /* auths accepted by server */
177 struct ssh_list *ssh_message_list; /* list of delayed SSH messages */
178 int (*ssh_message_callback)( struct ssh_session_struct *session, ssh_message msg, void *userdata);
179 void *ssh_message_callback_data;
180 ssh_server_callbacks server_callbacks;
181 void (*ssh_connection_callback)( struct ssh_session_struct *session);
182 struct ssh_packet_callbacks_struct default_packet_callbacks;
183 struct ssh_list *packet_callbacks;
184 struct ssh_socket_callbacks_struct socket_callbacks;
185 ssh_poll_ctx default_poll_ctx;
186 /* options */
187 #ifdef WITH_PCAP
188 ssh_pcap_context pcap_ctx; /* pcap debugging context */
189 #endif
190 struct {
191 struct ssh_list *identity;
192 char *username;
193 char *host;
194 char *bindaddr; /* bind the client to an ip addr */
195 char *sshdir;
196 char *knownhosts;
197 char *global_knownhosts;
198 char *wanted_methods[10];
199 char *ProxyCommand;
200 char *custombanner;
201 unsigned long timeout; /* seconds */
202 unsigned long timeout_usec;
203 unsigned int port;
204 socket_t fd;
205 int StrictHostKeyChecking;
206 char compressionlevel;
207 char *gss_server_identity;
208 char *gss_client_identity;
209 int gss_delegate_creds;
210 int flags;
211 int nodelay;
212 } opts;
213 /* counters */
214 ssh_counter socket_counter;
215 ssh_counter raw_counter;
216 };
217
223 typedef int (*ssh_termination_function)(void *user);
224 int ssh_handle_packets(ssh_session session, int timeout);
225 int ssh_handle_packets_termination(ssh_session session, int timeout,
226 ssh_termination_function fct, void *user);
227 void ssh_socket_exception_callback(int code, int errno_code, void *user);
228
229 #endif /* SESSION_H_ */
ssh_key_struct
Definition: pki.h:42
ssh_socket_callbacks_struct
Definition: callbacks.h:378
ssh_kbdint_struct
Definition: auth.h:37
ssh_crypto_struct
Definition: crypto.h:80
ssh_agent_struct
Definition: agent.h:70
ssh_callbacks_struct
Definition: callbacks.h:142
ssh_message_struct
Definition: messages.h:84
ssh_poll_ctx_struct
Definition: poll.c:76
ssh_packet_callbacks_struct
Definition: callbacks.h:530
ssh_session_struct
Definition: session.h:96
ssh_gssapi_struct
Definition: gssapi.c:48
packet_struct
Definition: packet.h:29
ssh_auth_auto_state_struct
Definition: auth.c:900
ssh_list
Definition: misc.h:38
ssh_server_callbacks_struct
Definition: callbacks.h:304
ssh_string_struct
Definition: string.h:29
ssh_agent_state_struct
Definition: auth.c:762
error_struct
Definition: priv.h:219
ssh_socket_struct
Definition: socket.c:76
ssh_common_struct
Definition: session.h:90
ssh_buffer_struct
Definition: buffer.h:34
ssh_counter_struct
Definition: libssh.h:108