S2OPC OPCUA Toolkit
Loading...
Searching...
No Matches
session_core_bs.h
Go to the documentation of this file.
1/*
2 * Licensed to Systerel under one or more contributor license
3 * agreements. See the NOTICE file distributed with this work
4 * for additional information regarding copyright ownership.
5 * Systerel licenses this file to you under the Apache
6 * License, Version 2.0 (the "License"); you may not use this
7 * file except in compliance with the License. You may obtain
8 * a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19
20/******************************************************************************
21
22 File Name : session_core_bs.h
23
24 Date : 27/11/2024 09:16:09
25
26 C Translator Version : tradc Java V1.2 (06/02/2022)
27
28******************************************************************************/
29
30#ifndef _session_core_bs_h
31#define _session_core_bs_h
32
33/*--------------------------
34 Added by the Translator
35 --------------------------*/
36#include "b2c.h"
37
38/*--------------
39 SEES Clause
40 --------------*/
41#include "channel_mgr.h"
42#include "constants.h"
44#include "message_in_bs.h"
45#include "message_out_bs.h"
46#include "request_handle_bs.h"
47
48/*------------------------
49 INITIALISATION Clause
50 ------------------------*/
52
53/*--------------------
54 OPERATIONS Clause
55 --------------------*/
57 const constants__t_SignatureData_i session_core_bs__p_signature);
59 const constants__t_session_i session_core_bs__session,
60 const constants__t_channel_config_idx_i session_core_bs__channel_config_idx,
61 const constants__t_Nonce_i session_core_bs__server_nonce,
62 t_bool * const session_core_bs__valid,
63 constants__t_SignatureData_i * const session_core_bs__signature);
65 const constants__t_session_i session_core_bs__p_session,
66 const constants__t_channel_config_idx_i session_core_bs__p_channel_config_idx,
67 const constants__t_msg_i session_core_bs__p_resp_msg,
68 t_bool * const session_core_bs__valid);
70 const constants__t_msg_i session_core_bs__req_msg);
72 const constants__t_msg_i session_core_bs__resp_msg);
74 const constants__t_session_i session_core_bs__p_session,
75 const constants__t_channel_config_idx_i session_core_bs__p_channel_config_idx,
76 const constants__t_msg_i session_core_bs__p_resp_msg,
77 t_bool * const session_core_bs__p_valid);
79 const constants__t_session_i session_core_bs__p_session,
80 const constants__t_channel_i session_core_bs__p_channel,
81 const constants__t_channel_config_idx_i session_core_bs__p_channel_config_idx,
82 t_bool * const session_core_bs__valid,
83 t_bool * const session_core_bs__nonce_needed);
85 const constants__t_session_i session_core_bs__p_session,
86 const constants__t_channel_config_idx_i session_core_bs__p_channel_config_idx,
87 const constants__t_msg_i session_core_bs__p_resp_msg,
88 t_bool * const session_core_bs__p_valid);
90 const constants__t_session_i session_core_bs__session,
91 const constants__t_channel_config_idx_i session_core_bs__channel_config_idx);
93 const constants__t_session_i session_core_bs__session,
94 const constants__t_user_token_i session_core_bs__p_user_token);
96 const constants__t_session_i session_core_bs__session,
97 const constants__t_channel_config_idx_i session_core_bs__channel_config_idx);
99 const constants__t_session_i session_core_bs__session,
100 constants__t_session_token_i * const session_core_bs__session_token);
102 const constants__t_session_i session_core_bs__p_session,
103 const constants__t_msg_i session_core_bs__p_resp_msg);
105 const constants__t_session_i session_core_bs__session,
106 const constants__t_session_token_i session_core_bs__token);
108 const constants__t_session_i session_core_bs__p_session);
110 const constants__t_session_i session_core_bs__p_session,
111 const t_bool session_core_bs__p_is_client);
113 const constants__t_session_i session_core_bs__p_session);
115 const constants__t_session_i session_core_bs__p_session);
117 const constants__t_session_i session_core_bs__p_session,
118 constants__t_Nonce_i * const session_core_bs__nonce);
120 const constants__t_session_i session_core_bs__p_session,
121 const t_bool session_core_bs__p_is_client,
122 constants__t_Nonce_i * const session_core_bs__nonce);
124 const constants__t_session_i session_core_bs__p_session,
125 constants__t_session_application_context_i * const session_core_bs__p_app_context);
127 const constants__t_session_i session_core_bs__session,
128 constants__t_user_token_i * const session_core_bs__p_user_token);
130 const constants__t_session_i session_core_bs__session,
131 constants__t_SecurityPolicy * const session_core_bs__p_user_secu);
133 const constants__t_session_i session_core_bs__session,
134 constants__t_user_i * const session_core_bs__p_user);
136 const constants__t_session_i session_core_bs__session,
137 constants__t_byte_buffer_i * const session_core_bs__p_user_server_cert);
139 const constants__t_user_i session_core_bs__p_user_left,
140 const constants__t_user_i session_core_bs__p_user_right,
141 t_bool * const session_core_bs__p_bres);
143 const constants__t_session_i session_core_bs__p_session,
144 const constants__t_channel_config_idx_i session_core_bs__p_channel_config_idx,
145 const constants__t_byte_buffer_i session_core_bs__p_user_server_cert,
146 const constants__t_SecurityPolicy session_core_bs__p_user_secu_policy,
147 t_bool * const session_core_bs__valid_cert);
149 const constants__t_session_i session_core_bs__session,
150 const constants__t_sessionState_i session_core_bs__prec_state,
151 const constants__t_sessionState_i session_core_bs__state,
152 const constants_statuscodes_bs__t_StatusCode_i session_core_bs__sc_reason,
153 const t_bool session_core_bs__is_client);
155 const constants__t_session_i session_core_bs__p_session,
156 const t_bool session_core_bs__p_is_client);
158 const constants__t_endpoint_config_idx_i session_core_bs__p_endpoint_config_idx,
159 const constants__t_session_i session_core_bs__p_session,
160 const constants__t_channel_i session_core_bs__p_channel,
161 const constants__t_channel_config_idx_i session_core_bs__p_channel_config_idx,
162 const constants__t_msg_i session_core_bs__p_activate_req_msg,
163 t_bool * const session_core_bs__p_valid);
165 const constants__t_msg_i session_core_bs__req_msg,
166 const constants__t_msg_i session_core_bs__resp_msg);
168 const constants__t_msg_i session_core_bs__p_req_msg,
169 const constants__t_endpoint_config_idx_i session_core_bs__p_endpoint_config_idx,
170 const constants__t_channel_config_idx_i session_core_bs__p_channel_config_idx,
171 constants_statuscodes_bs__t_StatusCode_i * const session_core_bs__status,
172 constants__t_SignatureData_i * const session_core_bs__signature);
174 const constants__t_channel_config_idx_i session_core_bs__p_channel_config_idx,
175 const constants__t_session_i session_core_bs__session,
176 constants__t_session_token_i * const session_core_bs__token);
178 const constants__t_session_token_i session_core_bs__session_token,
179 constants__t_session_i * const session_core_bs__session);
181 const constants__t_session_token_i session_core_bs__token,
182 t_bool * const session_core_bs__ret);
184 const constants__t_endpoint_config_idx_i session_core_bs__p_endpoint_config_idx,
185 const constants__t_channel_config_idx_i session_core_bs__p_channel_config_idx,
186 t_bool * const session_core_bs__p_bres);
188 const constants__t_session_i session_core_bs__session,
189 t_bool * const session_core_bs__expired);
191 const constants__t_session_i session_core_bs__session);
193 const constants__t_session_i session_core_bs__session,
194 const constants__t_msg_i session_core_bs__resp_msg,
195 t_bool * const session_core_bs__timer_created);
197 const constants__t_session_i session_core_bs__session);
199 const constants__t_session_i session_core_bs__p_session,
200 const constants__t_channel_config_idx_i session_core_bs__p_channel_config_idx,
201 t_bool * const session_core_bs__p_bres,
202 constants__t_Nonce_i * const session_core_bs__p_nonce);
204 const constants__t_session_i session_core_bs__session);
206 const constants__t_session_i session_core_bs__p_session,
207 t_bool * const session_core_bs__ret);
209 const constants__t_session_i session_core_bs__p_session,
210 const constants__t_session_application_context_i session_core_bs__p_app_context);
212 const constants__t_session_i session_core_bs__session,
213 const constants__t_user_token_i session_core_bs__p_user_token);
215 const constants__t_session_i session_core_bs__session,
216 const constants__t_user_i session_core_bs__p_user);
218 const constants__t_byte_buffer_i session_core_bs__p_user_server_cert,
219 const constants__t_Nonce_i session_core_bs__p_server_nonce,
220 const constants__t_SecurityPolicy session_core_bs__p_user_secu_policy,
221 const constants__t_session_application_context_i session_core_bs__app_context,
222 constants__t_SignatureData_i * const session_core_bs__p_user_token_signature);
223
224#endif
bool t_bool
Definition b2c.h:28
#define constants__t_Nonce_i
Definition constants.h:71
#define constants__t_endpoint_config_idx_i
Definition constants.h:94
#define constants__t_SignatureData_i
Definition constants.h:82
#define constants__t_user_i
Definition constants.h:122
constants__t_sessionState_i
Definition constants.h:308
#define constants__t_session_i
Definition constants.h:116
constants__t_SecurityPolicy
Definition constants.h:179
#define constants__t_msg_i
Definition constants.h:104
#define constants__t_session_application_context_i
Definition constants.h:115
#define constants__t_user_token_i
Definition constants.h:123
#define constants__t_session_token_i
Definition constants.h:117
#define constants__t_byte_buffer_i
Definition constants.h:89
#define constants__t_channel_config_idx_i
Definition constants.h:90
#define constants__t_channel_i
Definition constants.h:91
constants_statuscodes_bs__t_StatusCode_i
Definition constants_statuscodes_bs.h:46
void session_core_bs__server_may_need_user_token_encryption(const constants__t_endpoint_config_idx_i session_core_bs__p_endpoint_config_idx, const constants__t_channel_config_idx_i session_core_bs__p_channel_config_idx, t_bool *const session_core_bs__p_bres)
void session_core_bs__set_session_app_context(const constants__t_session_i session_core_bs__p_session, const constants__t_session_application_context_i session_core_bs__p_app_context)
void session_core_bs__notify_set_session_state(const constants__t_session_i session_core_bs__session, const constants__t_sessionState_i session_core_bs__prec_state, const constants__t_sessionState_i session_core_bs__state, const constants_statuscodes_bs__t_StatusCode_i session_core_bs__sc_reason, const t_bool session_core_bs__is_client)
void session_core_bs__server_session_timeout_msg_received(const constants__t_session_i session_core_bs__session)
void session_core_bs__client_gen_create_session_internal_event(const constants__t_session_i session_core_bs__session, const constants__t_channel_config_idx_i session_core_bs__channel_config_idx)
void session_core_bs__get_session_app_context(const constants__t_session_i session_core_bs__p_session, constants__t_session_application_context_i *const session_core_bs__p_app_context)
void session_core_bs__client_set_NonceServer(const constants__t_session_i session_core_bs__p_session, const constants__t_msg_i session_core_bs__p_resp_msg)
void session_core_bs__server_session_timeout_evaluation(const constants__t_session_i session_core_bs__session, t_bool *const session_core_bs__expired)
void session_core_bs__may_validate_server_certificate(const constants__t_session_i session_core_bs__p_session, const constants__t_channel_config_idx_i session_core_bs__p_channel_config_idx, const constants__t_byte_buffer_i session_core_bs__p_user_server_cert, const constants__t_SecurityPolicy session_core_bs__p_user_secu_policy, t_bool *const session_core_bs__valid_cert)
void session_core_bs__session_has_user_server(const constants__t_session_i session_core_bs__p_session, t_bool *const session_core_bs__ret)
void session_core_bs__get_NonceServer(const constants__t_session_i session_core_bs__p_session, const t_bool session_core_bs__p_is_client, constants__t_Nonce_i *const session_core_bs__nonce)
void session_core_bs__server_session_timeout_start_timer(const constants__t_session_i session_core_bs__session, const constants__t_msg_i session_core_bs__resp_msg, t_bool *const session_core_bs__timer_created)
void session_core_bs__get_NonceClient(const constants__t_session_i session_core_bs__p_session, constants__t_Nonce_i *const session_core_bs__nonce)
void session_core_bs__get_session_user_secu_client(const constants__t_session_i session_core_bs__session, constants__t_SecurityPolicy *const session_core_bs__p_user_secu)
void session_core_bs__client_gen_activate_orphaned_session_internal_event(const constants__t_session_i session_core_bs__session, const constants__t_channel_config_idx_i session_core_bs__channel_config_idx)
void session_core_bs__get_session_user_client(const constants__t_session_i session_core_bs__session, constants__t_user_token_i *const session_core_bs__p_user_token)
void session_core_bs__delete_session_token(const constants__t_session_i session_core_bs__p_session, const t_bool session_core_bs__p_is_client)
void session_core_bs__client_create_session_req_do_crypto(const constants__t_session_i session_core_bs__p_session, const constants__t_channel_i session_core_bs__p_channel, const constants__t_channel_config_idx_i session_core_bs__p_channel_config_idx, t_bool *const session_core_bs__valid, t_bool *const session_core_bs__nonce_needed)
void session_core_bs__server_create_session_req_do_crypto(const constants__t_msg_i session_core_bs__p_req_msg, const constants__t_endpoint_config_idx_i session_core_bs__p_endpoint_config_idx, const constants__t_channel_config_idx_i session_core_bs__p_channel_config_idx, constants_statuscodes_bs__t_StatusCode_i *const session_core_bs__status, constants__t_SignatureData_i *const session_core_bs__signature)
void session_core_bs__client_activate_session_resp_check(const constants__t_session_i session_core_bs__p_session, const constants__t_channel_config_idx_i session_core_bs__p_channel_config_idx, const constants__t_msg_i session_core_bs__p_resp_msg, t_bool *const session_core_bs__valid)
void session_core_bs__clear_Signature(const constants__t_SignatureData_i session_core_bs__p_signature)
void session_core_bs__client_activate_session_req_do_crypto(const constants__t_session_i session_core_bs__session, const constants__t_channel_config_idx_i session_core_bs__channel_config_idx, const constants__t_Nonce_i session_core_bs__server_nonce, t_bool *const session_core_bs__valid, constants__t_SignatureData_i *const session_core_bs__signature)
void session_core_bs__server_is_valid_session_token(const constants__t_session_token_i session_core_bs__token, t_bool *const session_core_bs__ret)
void session_core_bs__client_set_session_token(const constants__t_session_i session_core_bs__session, const constants__t_session_token_i session_core_bs__token)
void session_core_bs__server_set_fresh_nonce(const constants__t_session_i session_core_bs__p_session, const constants__t_channel_config_idx_i session_core_bs__p_channel_config_idx, t_bool *const session_core_bs__p_bres, constants__t_Nonce_i *const session_core_bs__p_nonce)
void session_core_bs__server_get_fresh_session_token(const constants__t_channel_config_idx_i session_core_bs__p_channel_config_idx, const constants__t_session_i session_core_bs__session, constants__t_session_token_i *const session_core_bs__token)
void session_core_bs__client_close_session_resp_msg(const constants__t_msg_i session_core_bs__resp_msg)
void session_core_bs__drop_NonceClient(const constants__t_session_i session_core_bs__p_session)
void session_core_bs__server_close_session_check_req(const constants__t_msg_i session_core_bs__req_msg, const constants__t_msg_i session_core_bs__resp_msg)
void session_core_bs__client_get_token_from_session(const constants__t_session_i session_core_bs__session, constants__t_session_token_i *const session_core_bs__session_token)
void session_core_bs__get_session_user_server_certificate(const constants__t_session_i session_core_bs__session, constants__t_byte_buffer_i *const session_core_bs__p_user_server_cert)
void session_core_bs__INITIALISATION(void)
void session_core_bs__set_session_user_server(const constants__t_session_i session_core_bs__session, const constants__t_user_i session_core_bs__p_user)
void session_core_bs__server_session_timeout_stop_timer(const constants__t_session_i session_core_bs__session)
void session_core_bs__get_session_user_server(const constants__t_session_i session_core_bs__session, constants__t_user_i *const session_core_bs__p_user)
void session_core_bs__is_same_user_server(const constants__t_user_i session_core_bs__p_user_left, const constants__t_user_i session_core_bs__p_user_right, t_bool *const session_core_bs__p_bres)
void session_core_bs__client_create_session_set_user_token_secu_properties(const constants__t_session_i session_core_bs__p_session, const constants__t_channel_config_idx_i session_core_bs__p_channel_config_idx, const constants__t_msg_i session_core_bs__p_resp_msg, t_bool *const session_core_bs__p_valid)
void session_core_bs__remove_NonceServer(const constants__t_session_i session_core_bs__p_session, const t_bool session_core_bs__p_is_client)
void session_core_bs__client_gen_activate_user_session_internal_event(const constants__t_session_i session_core_bs__session, const constants__t_user_token_i session_core_bs__p_user_token)
void session_core_bs__client_create_session_check_crypto(const constants__t_session_i session_core_bs__p_session, const constants__t_channel_config_idx_i session_core_bs__p_channel_config_idx, const constants__t_msg_i session_core_bs__p_resp_msg, t_bool *const session_core_bs__p_valid)
void session_core_bs__delete_session_application_context(const constants__t_session_i session_core_bs__p_session)
void session_core_bs__server_get_session_from_token(const constants__t_session_token_i session_core_bs__session_token, constants__t_session_i *const session_core_bs__session)
void session_core_bs__server_activate_session_check_crypto(const constants__t_endpoint_config_idx_i session_core_bs__p_endpoint_config_idx, const constants__t_session_i session_core_bs__p_session, const constants__t_channel_i session_core_bs__p_channel, const constants__t_channel_config_idx_i session_core_bs__p_channel_config_idx, const constants__t_msg_i session_core_bs__p_activate_req_msg, t_bool *const session_core_bs__p_valid)
void session_core_bs__client_close_session_req_msg(const constants__t_msg_i session_core_bs__req_msg)
void session_core_bs__drop_user_server(const constants__t_session_i session_core_bs__p_session)
void session_core_bs__session_do_nothing(const constants__t_session_i session_core_bs__session)
void session_core_bs__sign_user_token(const constants__t_byte_buffer_i session_core_bs__p_user_server_cert, const constants__t_Nonce_i session_core_bs__p_server_nonce, const constants__t_SecurityPolicy session_core_bs__p_user_secu_policy, const constants__t_session_application_context_i session_core_bs__app_context, constants__t_SignatureData_i *const session_core_bs__p_user_token_signature)
void session_core_bs__set_session_user_client(const constants__t_session_i session_core_bs__session, const constants__t_user_token_i session_core_bs__p_user_token)