mirror of https://github.com/wolfSSL/wolfssh.git
127 lines
4.0 KiB
C
127 lines
4.0 KiB
C
/* ssh.h
|
|
*
|
|
* Copyright (C) 2014 wolfSSL Inc.
|
|
*
|
|
* This file is part of wolfSSH.
|
|
*
|
|
* wolfSSH is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* wolfSSH is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor,
|
|
* Boston, MA 02110-1301, USA.
|
|
*/
|
|
|
|
|
|
/*
|
|
* The ssh module contains the public API for wolfSSH.
|
|
*/
|
|
|
|
|
|
#pragma once
|
|
|
|
#include <wolfssh/settings.h>
|
|
#include <wolfssh/version.h>
|
|
#include <wolfssh/port.h>
|
|
#include <wolfssh/error.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
|
|
typedef struct WOLFSSH_CTX WOLFSSH_CTX;
|
|
typedef struct WOLFSSH WOLFSSH;
|
|
|
|
|
|
WOLFSSH_API int wolfSSH_Init(void);
|
|
WOLFSSH_API int wolfSSH_Cleanup(void);
|
|
|
|
/* debugging output functions */
|
|
WOLFSSH_API int wolfSSH_Debugging_ON(void);
|
|
WOLFSSH_API void wolfSSH_Debugging_OFF(void);
|
|
|
|
/* context functions */
|
|
WOLFSSH_API WOLFSSH_CTX* wolfSSH_CTX_new(uint8_t, void*);
|
|
WOLFSSH_API void wolfSSH_CTX_free(WOLFSSH_CTX*);
|
|
|
|
/* ssh session functions */
|
|
WOLFSSH_API WOLFSSH* wolfSSH_new(WOLFSSH_CTX*);
|
|
WOLFSSH_API void wolfSSH_free(WOLFSSH*);
|
|
|
|
WOLFSSH_API int wolfSSH_set_fd(WOLFSSH*, int);
|
|
WOLFSSH_API int wolfSSH_get_fd(const WOLFSSH*);
|
|
|
|
WOLFSSH_API int wolfSSH_get_error(const WOLFSSH*);
|
|
WOLFSSH_API const char* wolfSSH_get_error_name(const WOLFSSH*);
|
|
|
|
/* I/O callbacks */
|
|
typedef int (*WS_CallbackIORecv)(WOLFSSH*, void*, uint32_t, void*);
|
|
typedef int (*WS_CallbackIOSend)(WOLFSSH*, void*, uint32_t, void*);
|
|
|
|
WOLFSSH_API void wolfSSH_SetIORecv(WOLFSSH_CTX*, WS_CallbackIORecv);
|
|
WOLFSSH_API void wolfSSH_SetIOSend(WOLFSSH_CTX*, WS_CallbackIOSend);
|
|
|
|
WOLFSSH_API void wolfSSH_SetIOReadCtx(WOLFSSH*, void*);
|
|
WOLFSSH_API void wolfSSH_SetIOWriteCtx(WOLFSSH*, void*);
|
|
|
|
WOLFSSH_API void* wolfSSH_GetIOReadCtx(WOLFSSH*);
|
|
WOLFSSH_API void* wolfSSH_GetIOWriteCtx(WOLFSSH*);
|
|
|
|
WOLFSSH_API int wolfSSH_CTX_UsePrivateKey_buffer(WOLFSSH_CTX*,
|
|
const uint8_t*, uint32_t, int);
|
|
WOLFSSH_API int wolfSSH_CTX_UseCert_buffer(WOLFSSH_CTX*,
|
|
const uint8_t*, uint32_t, int);
|
|
WOLFSSH_API int wolfSSH_CTX_UseCaCert_buffer(WOLFSSH_CTX*,
|
|
const uint8_t*, uint32_t, int);
|
|
|
|
WOLFSSH_API int wolfSSH_accept(WOLFSSH*);
|
|
WOLFSSH_API int wolfSSH_stream_read(WOLFSSH*, uint8_t*, uint32_t);
|
|
WOLFSSH_API int wolfSSH_stream_send(WOLFSSH*, uint8_t*, uint32_t);
|
|
|
|
|
|
enum WS_EndpointTypes {
|
|
WOLFSSH_ENDPOINT_SERVER,
|
|
WOLFSSH_ENDPOINT_CLIENT
|
|
};
|
|
|
|
|
|
enum WS_FormatTypes {
|
|
WOLFSSH_FORMAT_ASN1,
|
|
WOLFSSH_FORMAT_PEM,
|
|
WOLFSSH_FORMAT_RAW
|
|
};
|
|
|
|
|
|
enum WS_DisconnectReasonCodes {
|
|
WOLFSSH_DISCONNECT_HOST_NOT_ALLOWED_TO_CONNECT = 1,
|
|
WOLFSSH_DISCONNECT_PROTOCOL_ERROR = 2,
|
|
WOLFSSH_DISCONNECT_KEY_EXCHANGE_FAILED = 3,
|
|
WOLFSSH_DISCONNECT_RESERVED = 4,
|
|
WOLFSSH_DISCONNECT_MAC_ERROR = 5,
|
|
WOLFSSH_DISCONNECT_COMPRESSION_ERROR = 6,
|
|
WOLFSSH_DISCONNECT_SERVICE_NOT_AVAILABLE = 7,
|
|
WOLFSSH_DISCONNECT_PROTOCOL_VERSION_NOT_SUPPORTED = 8,
|
|
WOLFSSH_DISCONNECT_HOST_KEY_NOT_VERIFIABLE = 9,
|
|
WOLFSSH_DISCONNECT_CONNECTION_LOST = 10,
|
|
WOLFSSH_DISCONNECT_BY_APPLICATION = 11,
|
|
WOLFSSH_DISCONNECT_TOO_MANY_CONNECTIONS = 12,
|
|
WOLFSSH_DISCONNECT_AUTH_CANCELLED_BY_USER = 13,
|
|
WOLFSSH_DISCONNECT_NO_MORE_AUTH_METHODS_AVAILABLE = 14,
|
|
WOLFSSH_DISCONNECT_ILLEGAL_USER_NAME = 15
|
|
};
|
|
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|