↓

Filter results by

Older Versions

Older API versions are available as a download. To view, extract the file and open the index.html file in a web browser.

artik_ssl.h
Go to the documentation of this file.
1 /*
2  *
3  * Copyright 2017 Samsung Electronics All Rights Reserved.
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing,
12  * software distributed under the License is distributed on an
13  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
14  * either express or implied. See the License for the specific
15  * language governing permissions and limitations under the License.
16  *
17  */
18 
19 #ifndef INCLUDE_ARTIK_SSL_H_
20 #define INCLUDE_ARTIK_SSL_H_
21 
22 #include "artik_security.h"
23 
24 #ifdef __cplusplus
25 extern "C" {
26 #endif
27 
43 typedef enum {
44  ARTIK_SSL_VERIFY_NONE,
45  ARTIK_SSL_VERIFY_OPTIONAL,
46  ARTIK_SSL_VERIFY_REQUIRED
47 } artik_ssl_verify_t;
48 
54 typedef struct {
58  char *data;
62  unsigned int len;
63 } artik_ssl_certificate;
64 
70 typedef struct {
74  char *data;
78  unsigned int len;
79 } artik_ssl_key;
80 
81 
87 typedef struct {
92  bool use_se;
93 
97  artik_security_certificate_id certificate_id;
98 } artik_ssl_se_config;
99 
106 typedef struct {
110  artik_ssl_se_config se_config;
115  artik_ssl_certificate ca_cert;
121  artik_ssl_certificate client_cert;
127  artik_ssl_key client_key;
132  artik_ssl_verify_t verify_cert;
133 } artik_ssl_config;
134 
135 #ifdef __cplusplus
136 }
137 #endif
138 #endif /* INCLUDE_ARTIK_SSL_H_ */
artik_ssl_key::len
unsigned int len
Length in bytes of the key's data.
Definition: artik_ssl.h:78
artik_security.h
Security module definition.
artik_ssl_certificate::len
unsigned int len
Length in bytes of the certificate's data.
Definition: artik_ssl.h:62
artik_ssl_se_config::use_se
bool use_se
If true, use certificate and key stored in the Secure Element for SSL handshake.
Definition: artik_ssl.h:92
artik_ssl_se_config::certificate_id
artik_security_certificate_id certificate_id
The selected certificate for the SSL handshake.
Definition: artik_ssl.h:97
artik_ssl_key::data
char * data
Pointer to the key's data.
Definition: artik_ssl.h:74
artik_ssl_config::client_cert
artik_ssl_certificate client_cert
If certificate's data is non-null, use it as the client certificate to send to the server during SSL ...
Definition: artik_ssl.h:121
artik_ssl_config::se_config
artik_ssl_se_config se_config
Secure Element configuration.
Definition: artik_ssl.h:110
artik_ssl_config::ca_cert
artik_ssl_certificate ca_cert
If certificate's data is non-null, use it as trusted root CA for verifying the server's certificate...
Definition: artik_ssl.h:115
artik_ssl_se_config
Secure Element configuration.
Definition: artik_ssl.h:87
artik_security_certificate_id
artik_security_certificate_id
Certificate identifier.
Definition: artik_security.h:65
artik_ssl_key
SSL key structure.
Definition: artik_ssl.h:70
artik_ssl_verify_t
artik_ssl_verify_t
SSL verification strategy.
Definition: artik_ssl.h:43
artik_ssl_config::verify_cert
artik_ssl_verify_t verify_cert
Select the level of verification of the server certificate authenticity via trusted root CA...
Definition: artik_ssl.h:132
artik_ssl_certificate
SSL certificate structure.
Definition: artik_ssl.h:54
artik_ssl_config::client_key
artik_ssl_key client_key
If key's data is non-null, use it as the client private key to send to the server during SSL handshak...
Definition: artik_ssl.h:127
artik_ssl_certificate::data
char * data
Pointer to the certificate's data.
Definition: artik_ssl.h:58
artik_ssl_config
SSL configuration structure.
Definition: artik_ssl.h:106
Last updated on: