Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.4.4.5
openapi_ssh.h
Go to the documentation of this file.
1 
9 /*********************************************************************
10 *
11 * Copyright 2016-2019 Broadcom.
12 *
13 * Licensed under the Apache License, Version 2.0 (the "License");
14 * you may not use this file except in compliance with the License.
15 * You may obtain a copy of the License at
16 *
17 * http://www.apache.org/licenses/LICENSE-2.0
18 *
19 * Unless required by applicable law or agreed to in writing, software
20 * distributed under the License is distributed on an "AS IS" BASIS,
21 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
22 * See the License for the specific language governing permissions and
23 * limitations under the License.
24 *
25 **********************************************************************
26 *
27 * @filename openapi_ssh.h
28 *
29 * @purpose SSH Configuration and Status
30 *
31 * @component OpEN
32 *
33 * @create 30/01/2013
34 *
35 * @end
36 *
37 **********************************************************************/
38 #ifndef OPENAPI_SSH_H_INCLUDED
39 #define OPENAPI_SSH_H_INCLUDED
40 
41 #include "openapi_common.h"
42 #include "openapi_logging.h"
43 
45 typedef enum
46 {
47  OPEN_SSH_KEY_TYPE_RSA = 0,
48  OPEN_SSH_KEY_TYPE_DSA = 1
49 } OPEN_SSH_KEY_TYPE_t;
50 
52 typedef enum
53 {
54  OPEN_SSH_PROTO_VERSION_1 = 0, /* SSH Protocol Version 1 option not supported */
55  OPEN_SSH_PROTO_VERSION_2 = 1,
56  OPEN_SSH_PROTO_VERSION_BOTH = 2
57 } OPEN_SSH_PROTO_VERSION_t;
58 
59 
60 /*****************************************************************/
79 open_error_t openapiSSHKeyGenerate(openapiClientHandle_t *client_handle,
80  OPEN_SSH_KEY_TYPE_t sshKeyType);
81 
82 /*****************************************************************/
99 open_error_t openapiSSHKeyDelete(openapiClientHandle_t *client_handle,
100  OPEN_SSH_KEY_TYPE_t sshKeyType);
101 
102 /*****************************************************************/
121 open_error_t openapiSSHAdminModeSet(openapiClientHandle_t *client_handle,
122  OPEN_CONTROL_t sshAdminMode);
123 
124 /*****************************************************************/
139 open_error_t openapiSSHAdminModeGet(openapiClientHandle_t *client_handle,
140  OPEN_CONTROL_t *sshAdminMode);
141 
142 /*****************************************************************/
161 open_error_t openapiSSHProtocolVersionSet(openapiClientHandle_t *client_handle,
162  OPEN_SSH_PROTO_VERSION_t protoVersion);
163 
164 /*****************************************************************/
176 open_error_t openapiSSHProtocolVersionGet(openapiClientHandle_t *client_handle,
177  OPEN_SSH_PROTO_VERSION_t *protoVersion);
178 
179 /*****************************************************************/
196 open_error_t openapiSSHSessionTimeoutSet(openapiClientHandle_t *client_handle,
197  uint32_t sshSessionTimeout);
198 
199 /*****************************************************************/
212 open_error_t openapiSSHSessionTimeoutGet(openapiClientHandle_t *client_handle,
213  uint32_t *sshSessionTimeout);
214 
215 /*****************************************************************/
232 open_error_t openapiSSHMaxSessionsSet(openapiClientHandle_t *client_handle,
233  uint32_t sshMaxSessions);
234 
235 /*****************************************************************/
249 open_error_t openapiSSHMaxSessionsDefaultSet(openapiClientHandle_t *client_handle);
250 
251 /*****************************************************************/
263 open_error_t openapiSSHMaxSessionsGet(openapiClientHandle_t *client_handle,
264  uint32_t *sshMaxSessions);
265 
266 /*****************************************************************/
279 open_error_t openapiSSHActiveSessionsGet(openapiClientHandle_t *client_handle,
280  uint32_t *sshActiveSessions);
281 
282 /*****************************************************************/
295 open_error_t openapiSSHSocketInfoClear(openapiClientHandle_t *client_handle,
296  uint32_t sshClientID);
297 
298 /*****************************************************************/
315 open_error_t openapiSSHKeyStatusGet(openapiClientHandle_t *client_handle,
316  OPEN_SSH_KEY_TYPE_t sshKeyType);
317 
318 /*****************************************************************/
336 open_error_t openapiSSHUserAuthenticate(openapiClientHandle_t *client_handle,
337  open_buffdesc *userName, open_buffdesc *password,
338  open_buffdesc *ipAddr, uint32_t sshClientID);
339 
340 /*****************************************************************/
357 open_error_t openapiSSHPublicUserAuthenticate(openapiClientHandle_t *client_handle,
358  open_buffdesc *userName, open_buffdesc *ipAddr,
359  uint32_t sshClientID);
360 
361 /*****************************************************************/
376 open_error_t openapiSSHPubKeyAuthModeGet(openapiClientHandle_t *client_handle,
377  OPEN_CONTROL_t *sshdPubKeyAuthMode);
378 
379 /*****************************************************************/
396 open_error_t openapiSSHPubKeyGet(openapiClientHandle_t *client_handle,
397  OPEN_SSH_KEY_TYPE_t sshKeyType,
398  open_buffdesc *userName,
399  open_buffdesc *pubKey);
400 
401 /*****************************************************************/
416 open_error_t openapiSSHLogMessage(openapiClientHandle_t *client_handle,
417  OPEN_LOG_SEVERITY_t severity, open_buffdesc *fileName,
418  uint32_t lineNum, open_buffdesc *msgBuf);
419 
420 
421 /*****************************************************************/
434 open_error_t openapiSSHTransferRemotePasswordFromUserGet(openapiClientHandle_t *client_handle,
435  open_buffdesc *userName,
436  open_buffdesc *password);
437 
438 
439 /*****************************************************************/
455 open_error_t openapiScpServerAdminModeSet (openapiClientHandle_t *client_handle,
456  OPEN_CONTROL_t scpServerAdminMode);
457 
458 /*****************************************************************/
474 open_error_t openapiScpServerAdminModeGet (openapiClientHandle_t *client_handle,
475  OPEN_CONTROL_t *scpServerAdminMode);
476 
477 /*****************************************************************/
512 open_error_t openapiScpRemoteTransferStart (openapiClientHandle_t *client_handle,
513  int32_t scpClientPID,
514  open_buffdesc *fileParams);
515 
516 /*****************************************************************/
528 open_error_t openapiScpRemoteTransferComplete (openapiClientHandle_t *client_handle);
529 #endif
530