NetBurner 3.1
SSH/SecureSerToEthFactoryApp/ssluser.h
1 /* Revision: 2.8.7 */
2 
3 /******************************************************************************
4 * Copyright 1998-2018 NetBurner, Inc. ALL RIGHTS RESERVED
5 *
6 * Permission is hereby granted to purchasers of NetBurner Hardware to use or
7 * modify this computer program for any use as long as the resultant program
8 * is only executed on NetBurner provided hardware.
9 *
10 * No other rights to use this program or its derivatives in part or in
11 * whole are granted.
12 *
13 * It may be possible to license this or other NetBurner software for use on
14 * non-NetBurner Hardware. Contact sales@Netburner.com for more information.
15 *
16 * NetBurner makes no representation or warranties with respect to the
17 * performance of this computer program, and specifically disclaims any
18 * responsibility for any damages, special or consequential, connected with
19 * the use of this program.
20 *
21 * NetBurner
22 * 5405 Morehouse Dr.
23 * San Diego, CA 92121
24 * www.netburner.com
25 ******************************************************************************/
26 
27 
28 #ifndef _SSLUSER_H_
29 #define _SSLUSER_H_
30 
31 /* NB Secure Sockets Layer (SSL) */
32 #include <crypto/ssl.h>
33 
34 /*
35  ******************************************************************************
36  ******************************************************************************
37  *
38  * OpenSSL format is Privacy-enhanced Electronic Mail (PEM) encoded
39  *
40  ******************************************************************************
41  ******************************************************************************
42  */
43 
44 /*
45  ******************************************************************************
46  *
47  * Global data definitions
48  *
49  ******************************************************************************
50  */
51 /* Default or installed user PEM encoded certificate */
52 extern char gSslCert
53  [ ( SERIAL_BURNER_CERTIFICATE_SIZE_MAX_PEM + 1 ) ];
54 extern char gSslKey
55  [ ( SERIAL_BURNER_KEY_SIZE_MAX_PEM + 1 ) ];
56 
57 /*
58  ******************************************************************************
59  *
60  * Functions
61  *
62  ******************************************************************************
63  */
64 /*
65  ******************************************************************************
66  *
67  * "C" Routines
68  *
69  ******************************************************************************
70  */
71 #ifdef __cplusplus
72 extern "C" {
73 #endif
74 /*
75  ******************************************************************************
76 
77  Checks and installs SSL default certificate and key
78 
79  Parameters:
80  None
81 
82  Return:
83  None
84 
85  Notes:
86  Sets NV_Settings elements:
87  SslCertificateSource;
88  SslCertificateLength;
89  SslKeyLength;
90 
91 
92  ******************************************************************************
93  */
94 void SslUserSetDefault( void );
95 
96 /*
97  ******************************************************************************
98 
99  Retrieves and set certificate and key
100 
101  Parameters:
102  None
103 
104  Return:
105  None
106 
107  Notes:
108  Clears SSL settings for CertificateNKeysDataStatus element of
109  struct NV_SettingsStruct if retrieval error occurs
110 
111  ******************************************************************************
112  */
113 void SslUserRetrieveCertificateNKey( void );
114 
115 #ifdef __cplusplus
116 };
117 #endif
118 
119 /*
120  ******************************************************************************
121  *
122  * "C++" Routines
123  *
124  ******************************************************************************
125  */
126 
127 #endif /* _SSLUSER_H_ */
128 
129 
NetBurner SSL API.