/usr/include/yuma/mgr/mgr_ses.h is in libyuma-dev 2.10-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 | /*
* Copyright (c) 2008 - 2012, Andy Bierman, All Rights Reserved.
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
#ifndef _H_mgr_ses
#define _H_mgr_ses
/* FILE: mgr_ses.h
*********************************************************************
* *
* P U R P O S E *
* *
*********************************************************************
NETCONF Session Manager definitions module
*********************************************************************
* *
* C H A N G E H I S T O R Y *
* *
*********************************************************************
date init comment
----------------------------------------------------------------------
08-feb-07 abb Begun; started from agt_ses.h
*/
#include <xmlstring.h>
#ifndef _H_ncxconst
#include "ncxconst.h"
#endif
#ifndef _H_ncxmod
#include "ncxmod.h"
#endif
#ifndef _H_ses
#include "ses.h"
#endif
#ifndef _H_status
#include "status.h"
#endif
#ifndef _H_xpath
#include "xpath.h"
#endif
#ifdef __cplusplus
extern "C" {
#endif
/********************************************************************
* *
* C O N S T A N T S *
* *
*********************************************************************/
/********************************************************************
* *
* T Y P E S *
* *
*********************************************************************/
/********************************************************************
* *
* F U N C T I O N S *
* *
*********************************************************************/
/********************************************************************
* FUNCTION mgr_ses_init
*
* Initialize the session manager module data structures
*
* INPUTS:
* none
* RETURNS:
* none
*********************************************************************/
extern void
mgr_ses_init (void);
/********************************************************************
* FUNCTION mgr_ses_cleanup
*
* Cleanup the session manager module data structures
*
* INPUTS:
* none
* RETURNS:
* none
*********************************************************************/
extern void
mgr_ses_cleanup (void);
/********************************************************************
* FUNCTION mgr_ses_new_session
*
* Create a new session control block and
* start a NETCONF session with to the specified server
*
* After this functions returns OK, the session state will
* be in HELLO_WAIT state. An server <hello> must be received
* before any <rpc> requests can be sent
*
* The pubkeyfile and privkeyfile parameters will be used first.
* If this fails, the password parameter will be checked
*
* INPUTS:
* user == user name
* password == user password
* pubkeyfile == filespec for client public key
* privkeyfile == filespec for client private key
* target == ASCII IP address or DNS hostname of target
* port == NETCONF port number to use, or 0 to use defaults
* transport == enum for the transport to use (SSH or TCP)
* progcb == temp program instance control block,
* == NULL if a session temp files control block is not
* needed
* retsid == address of session ID output
* getvar_cb == XPath get varbind callback function
* protocols_parent == pointer to val_value_t that may contain
* a session-specific --protocols variable to set
* == NULL if not used
*
* OUTPUTS:
* *retsid == session ID, if no error
*
* RETURNS:
* status
*********************************************************************/
extern status_t
mgr_ses_new_session (const xmlChar *user,
const xmlChar *password,
const char *pubkeyfile,
const char *privkeyfile,
const xmlChar *target,
uint16 port,
ses_transport_t transport,
ncxmod_temp_progcb_t *progcb,
ses_id_t *retsid,
xpath_getvar_fn_t getvar_fn,
val_value_t *protocols_parent);
/********************************************************************
* FUNCTION mgr_ses_free_session
*
* Free a real session control block
*
* INPUTS:
* scb == session control block to free
*
*********************************************************************/
extern void
mgr_ses_free_session (ses_id_t sid);
/********************************************************************
* FUNCTION mgr_ses_new_dummy_session
*
* Create a dummy session control block
*
* INPUTS:
* none
* RETURNS:
* pointer to initialized dummy SCB, or NULL if malloc error
*********************************************************************/
extern ses_cb_t *
mgr_ses_new_dummy_session (void);
/********************************************************************
* FUNCTION mgr_ses_free_dummy_session
*
* Free a dummy session control block
*
* INPUTS:
* scb == session control block to free
*
*********************************************************************/
extern void
mgr_ses_free_dummy_session (ses_cb_t *scb);
/********************************************************************
* FUNCTION mgr_ses_process_first_ready
*
* Check the readyQ and process the first message, if any
*
* RETURNS:
* TRUE if a message was processed
* FALSE if the readyQ was empty
*********************************************************************/
extern boolean
mgr_ses_process_first_ready (void);
/********************************************************************
* FUNCTION mgr_ses_fill_writeset
*
* Drain the ses_msg outreadyQ and set the specified fdset
* Used by mgr_ncxserver write_fd_set
*
* INPUTS:
* fdset == pointer to fd_set to fill
* maxfdnum == pointer to max fd int to fill in
*
* OUTPUTS:
* *fdset is updated in
* *maxfdnum may be updated
*
* RETURNS:
* number of ready-for-output sessions found
*********************************************************************/
extern uint32
mgr_ses_fill_writeset (fd_set *fdset,
int *maxfdnum);
/********************************************************************
* FUNCTION mgr_ses_get_first_outready
*
* Get the first ses_msg outreadyQ entry
* Will remove the entry from the Q
*
* RETURNS:
* pointer to the session control block of the
* first session ready to write output to a socket
* or the screen or a file
*********************************************************************/
extern ses_cb_t *
mgr_ses_get_first_outready (void);
/********************************************************************
* FUNCTION mgr_ses_get_first_session
*
* Get the first active session
*
* RETURNS:
* pointer to the session control block of the
* first active session found
*********************************************************************/
extern ses_cb_t *
mgr_ses_get_first_session (void);
/********************************************************************
* FUNCTION mgr_ses_get_next_session
*
* Get the next active session
*
* INPUTS:
* curscb == current session control block to use
*
* RETURNS:
* pointer to the session control block of the
* next active session found
*
*********************************************************************/
extern ses_cb_t *
mgr_ses_get_next_session (ses_cb_t *curscb);
/********************************************************************
* FUNCTION mgr_ses_readfn
*
* Read callback function for a manager SSH2 session
*
* INPUTS:
* s == session control block
* buff == buffer to fill
* bufflen == length of buff
* erragain == address of return EAGAIN flag
*
* OUTPUTS:
* *erragain == TRUE if ret value < zero means
* read would have blocked (not really an error)
* FALSE if the ret value is not < zero, or
* if it is, it is a real error
*
* RETURNS:
* number of bytes read; -1 for error; 0 for connection closed
*********************************************************************/
extern ssize_t
mgr_ses_readfn (void *scb,
char *buff,
size_t bufflen,
boolean *erragain);
/********************************************************************
* FUNCTION mgr_ses_writefn
*
* Write callback function for a manager SSH2 session
*
* INPUTS:
* s == session control block
*
* RETURNS:
* status of the write operation
*********************************************************************/
extern status_t
mgr_ses_writefn (void *scb);
/********************************************************************
* FUNCTION mgr_ses_get_scb
*
* Retrieve the session control block
*
* INPUTS:
* sid == manager session ID (not agent assigned ID)
*
* RETURNS:
* pointer to session control block or NULL if invalid
*********************************************************************/
extern ses_cb_t *
mgr_ses_get_scb (ses_id_t sid);
/********************************************************************
* FUNCTION mgr_ses_get_mscb
*
* Retrieve the manager session control block
*
* INPUTS:
* scb == session control block to use
*
* RETURNS:
* pointer to manager session control block or NULL if invalid
*********************************************************************/
extern mgr_scb_t *
mgr_ses_get_mscb (ses_cb_t *scb);
#ifdef __cplusplus
} /* end extern 'C' */
#endif
#endif /* _H_mgr_ses */
|