S2OPC OPCUA Toolkit
Loading...
Searching...
No Matches
session_core.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.h
23
24 Date : 27/11/2024 09:15:51
25
26 C Translator Version : tradc Java V1.2 (06/02/2022)
27
28******************************************************************************/
29
30#ifndef _session_core_h
31#define _session_core_h
32
33/*--------------------------
34 Added by the Translator
35 --------------------------*/
36#include "b2c.h"
37
38/*-----------------
39 IMPORTS Clause
40 -----------------*/
41#include "msg_session_bs.h"
42#include "session_channel_it.h"
43#include "session_core_1.h"
44#include "session_core_it.h"
45#include "user_authentication.h"
46
47/*--------------
48 SEES Clause
49 --------------*/
50#include "channel_mgr.h"
51#include "constants.h"
53#include "message_in_bs.h"
54#include "message_out_bs.h"
55#include "request_handle_bs.h"
56#include "time_reference_bs.h"
57
58/*------------------------
59 INITIALISATION Clause
60 ------------------------*/
62
63/*-------------------------------
64 PROMOTES and EXTENDS Clauses
65 -------------------------------*/
66#define session_core__allocate_x509_token_from_user user_authentication__allocate_x509_token_from_user
67#define session_core__client_gen_activate_orphaned_session_internal_event session_core_1__client_gen_activate_orphaned_session_internal_event
68#define session_core__client_gen_activate_user_session_internal_event session_core_1__client_gen_activate_user_session_internal_event
69#define session_core__client_gen_create_session_internal_event session_core_1__client_gen_create_session_internal_event
70#define session_core__client_get_token_from_session session_core_1__client_get_token_from_session
71#define session_core__deallocate_user user_authentication__deallocate_user
72#define session_core__deallocate_x509_token user_authentication__deallocate_x509_token
73#define session_core__drop_user_server session_core_1__drop_user_server
74#define session_core__get_channel_nb_sessions session_core_1__get_channel_nb_sessions
75#define session_core__get_local_user user_authentication__get_local_user
76#define session_core__get_server_session_preferred_locales session_core_1__get_server_session_preferred_locales
77#define session_core__get_session_channel session_core_1__get_session_channel
78#define session_core__get_session_user_client session_core_1__get_session_user_client
79#define session_core__get_session_user_server session_core_1__get_session_user_server
80#define session_core__getall_orphaned session_core_1__getall_orphaned
81#define session_core__getall_session_channel session_core_1__getall_session_channel
82#define session_core__getall_to_create session_core_1__getall_to_create
83#define session_core__has_user_token_policy_available user_authentication__has_user_token_policy_available
84#define session_core__is_valid_session session_core_1__is_valid_session
85#define session_core__is_valid_user_x509_authentication user_authentication__is_valid_user_x509_authentication
86#define session_core__reset_session_to_create session_core_1__reset_session_to_create
87#define session_core__server_get_session_from_token session_core_1__server_get_session_from_token
88#define session_core__server_session_timeout_evaluation session_core_1__server_session_timeout_evaluation
89#define session_core__server_session_timeout_msg_received session_core_1__server_session_timeout_msg_received
90#define session_core__server_session_timeout_start_timer session_core_1__server_session_timeout_start_timer
91#define session_core__session_has_user_server session_core_1__session_has_user_server
92#define session_core__set_session_app_context session_core_1__set_session_app_context
93#define session_core__set_session_to_create session_core_1__set_session_to_create
94#define session_core__set_session_user_client session_core_1__set_session_user_client
95
96/*--------------------------
97 LOCAL_OPERATIONS Clause
98 --------------------------*/
100 const t_bool session_core__p_dom,
101 const constants__t_channel_i session_core__p_channel,
102 const constants__t_channel_i session_core__p_lost_channel,
103 const constants__t_session_i session_core__p_session,
104 const constants__t_channel_config_idx_i session_core__p_channel_config_idx);
106 const t_bool session_core__p_dom,
107 const constants__t_channel_i session_core__p_channel,
108 const constants__t_channel_i session_core__p_lost_channel,
109 const constants__t_session_i session_core__p_session);
111 const constants__t_channel_i session_core__channel,
112 const constants__t_session_i session_core__session,
113 const constants__t_sessionState_i session_core__transitoryState,
114 const constants__t_user_i session_core__p_user,
115 const constants__t_msg_i session_core__activate_req_msg,
116 const constants__t_msg_i session_core__activate_resp_msg,
117 t_bool * const session_core__res_activated);
118
119/*--------------------
120 OPERATIONS Clause
121 --------------------*/
123 const constants__t_channel_i session_core__p_channel,
124 const constants__t_session_i session_core__p_session,
125 const constants__t_user_token_i session_core__p_user_token,
126 const constants__t_SignatureData_i session_core__p_user_token_signature,
127 constants_statuscodes_bs__t_StatusCode_i * const session_core__p_sc_valid_user,
128 t_bool * const session_core__p_max_attempts,
129 constants__t_user_i * const session_core__p_user);
131 const constants__t_channel_i session_core__channel,
132 const constants__t_session_i session_core__session,
133 const constants__t_msg_i session_core__activate_resp_msg,
134 t_bool * const session_core__bret);
136 const constants__t_session_i session_core__session,
137 const constants__t_msg_i session_core__close_req_msg,
138 constants_statuscodes_bs__t_StatusCode_i * const session_core__ret,
139 constants__t_channel_i * const session_core__channel,
140 constants__t_session_token_i * const session_core__session_token);
142 const constants__t_channel_i session_core__channel,
143 const constants__t_session_i session_core__session,
144 const constants__t_msg_i session_core__close_resp_msg);
146 const constants__t_session_i session_core__session,
147 const constants_statuscodes_bs__t_StatusCode_i session_core__sc_reason);
149 const constants__t_session_i session_core__session,
150 const constants__t_channel_i session_core__channel,
151 const constants__t_msg_i session_core__create_req_msg,
152 t_bool * const session_core__valid);
154 const constants__t_channel_i session_core__channel,
155 const constants__t_session_i session_core__session,
156 const constants__t_session_token_i session_core__session_token,
157 const constants__t_msg_i session_core__create_resp_msg,
158 t_bool * const session_core__bret);
160 constants__t_session_i * const session_core__nsession);
162 const constants__t_session_i session_core__session,
163 const constants__t_channel_i session_core__channel,
164 const constants__t_msg_i session_core__activate_req_msg,
165 constants__t_session_token_i * const session_core__session_token);
167 const constants__t_channel_i session_core__p_lost_channel,
168 const constants__t_channel_config_idx_i session_core__p_channel_config_idx);
170 const constants__t_session_i session_core__session,
171 const constants__t_user_token_i session_core__p_user_token,
172 const constants__t_msg_i session_core__activate_req_msg,
173 constants_statuscodes_bs__t_StatusCode_i * const session_core__ret,
174 constants__t_channel_i * const session_core__channel,
175 constants__t_session_token_i * const session_core__session_token);
177 t_bool * const session_core__p_has_channel_to_close,
178 constants__t_channel_i * const session_core__p_channel_to_close);
180 const constants__t_session_i session_core__session,
181 constants__t_sessionState_i * const session_core__state);
183 const constants__t_session_i session_core__session,
184 t_bool * const session_core__bres,
185 constants__t_channel_i * const session_core__channel);
187 const constants__t_channel_i session_core__channel,
188 const constants__t_session_i session_core__session,
189 t_bool * const session_core__ret);
192 const constants__t_channel_i session_core__channel,
193 const constants__t_session_i session_core__session,
194 const constants__t_user_i session_core__user,
195 const constants__t_msg_i session_core__activate_req_msg,
196 const constants__t_msg_i session_core__activate_resp_msg,
197 constants_statuscodes_bs__t_StatusCode_i * const session_core__ret);
199 const constants__t_channel_i session_core__channel,
200 const constants__t_session_i session_core__session,
201 const constants__t_msg_i session_core__close_req_msg,
202 const constants__t_msg_i session_core__close_resp_msg,
203 constants_statuscodes_bs__t_StatusCode_i * const session_core__ret);
205 const constants__t_session_i session_core__session,
206 const constants_statuscodes_bs__t_StatusCode_i session_core__sc_reason);
208 const constants__t_channel_i session_core__channel,
209 const constants__t_msg_i session_core__create_req_msg,
210 const constants__t_msg_i session_core__create_resp_msg,
211 constants__t_session_i * const session_core__nsession,
212 constants_statuscodes_bs__t_StatusCode_i * const session_core__service_ret);
214 const constants__t_channel_i session_core__p_lost_channel);
216
217#endif
bool t_bool
Definition b2c.h:28
#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
#define constants__t_msg_i
Definition constants.h:104
#define constants__t_user_token_i
Definition constants.h:123
#define constants__t_session_token_i
Definition constants.h:117
#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__client_close_session_sm(const constants__t_session_i session_core__session, const constants_statuscodes_bs__t_StatusCode_i session_core__sc_reason)
void session_core__INITIALISATION(void)
void session_core__server_close_session_req_and_resp_sm(const constants__t_channel_i session_core__channel, const constants__t_session_i session_core__session, const constants__t_msg_i session_core__close_req_msg, const constants__t_msg_i session_core__close_resp_msg, constants_statuscodes_bs__t_StatusCode_i *const session_core__ret)
void session_core__server_create_session_req_and_resp_sm(const constants__t_channel_i session_core__channel, const constants__t_msg_i session_core__create_req_msg, const constants__t_msg_i session_core__create_resp_msg, constants__t_session_i *const session_core__nsession, constants_statuscodes_bs__t_StatusCode_i *const session_core__service_ret)
void session_core__server_activate_session_req_and_resp_sm(const constants__t_channel_i session_core__channel, const constants__t_session_i session_core__session, const constants__t_user_i session_core__user, const constants__t_msg_i session_core__activate_req_msg, const constants__t_msg_i session_core__activate_resp_msg, constants_statuscodes_bs__t_StatusCode_i *const session_core__ret)
void session_core__client_create_session_req_sm(const constants__t_session_i session_core__session, const constants__t_channel_i session_core__channel, const constants__t_msg_i session_core__create_req_msg, t_bool *const session_core__valid)
void session_core__l_client_secure_channel_lost_session_sm(const t_bool session_core__p_dom, const constants__t_channel_i session_core__p_channel, const constants__t_channel_i session_core__p_lost_channel, const constants__t_session_i session_core__p_session, const constants__t_channel_config_idx_i session_core__p_channel_config_idx)
void session_core__session_core_UNINITIALISATION(void)
void session_core__client_user_activate_session_req_sm(const constants__t_session_i session_core__session, const constants__t_user_token_i session_core__p_user_token, const constants__t_msg_i session_core__activate_req_msg, constants_statuscodes_bs__t_StatusCode_i *const session_core__ret, constants__t_channel_i *const session_core__channel, constants__t_session_token_i *const session_core__session_token)
void session_core__client_init_session_sm(constants__t_session_i *const session_core__nsession)
void session_core__allocate_authenticated_user(const constants__t_channel_i session_core__p_channel, const constants__t_session_i session_core__p_session, const constants__t_user_token_i session_core__p_user_token, const constants__t_SignatureData_i session_core__p_user_token_signature, constants_statuscodes_bs__t_StatusCode_i *const session_core__p_sc_valid_user, t_bool *const session_core__p_max_attempts, constants__t_user_i *const session_core__p_user)
void session_core__client_close_session_req_sm(const constants__t_session_i session_core__session, const constants__t_msg_i session_core__close_req_msg, constants_statuscodes_bs__t_StatusCode_i *const session_core__ret, constants__t_channel_i *const session_core__channel, constants__t_session_token_i *const session_core__session_token)
void session_core__may_close_unactivated_session(void)
void session_core__getall_valid_session_channel(const constants__t_session_i session_core__session, t_bool *const session_core__bres, constants__t_channel_i *const session_core__channel)
void session_core__server_close_session_sm(const constants__t_session_i session_core__session, const constants_statuscodes_bs__t_StatusCode_i session_core__sc_reason)
void session_core__is_session_valid_for_service(const constants__t_channel_i session_core__channel, const constants__t_session_i session_core__session, t_bool *const session_core__ret)
void session_core__server_secure_channel_lost_session_sm(const constants__t_channel_i session_core__p_lost_channel)
void session_core__get_session_state_or_closed(const constants__t_session_i session_core__session, constants__t_sessionState_i *const session_core__state)
void session_core__client_close_session_resp_sm(const constants__t_channel_i session_core__channel, const constants__t_session_i session_core__session, const constants__t_msg_i session_core__close_resp_msg)
void session_core__server_internal_activate_req_and_resp(const constants__t_channel_i session_core__channel, const constants__t_session_i session_core__session, const constants__t_sessionState_i session_core__transitoryState, const constants__t_user_i session_core__p_user, const constants__t_msg_i session_core__activate_req_msg, const constants__t_msg_i session_core__activate_resp_msg, t_bool *const session_core__res_activated)
void session_core__client_sc_activate_session_req_sm(const constants__t_session_i session_core__session, const constants__t_channel_i session_core__channel, const constants__t_msg_i session_core__activate_req_msg, constants__t_session_token_i *const session_core__session_token)
void session_core__l_server_secure_channel_lost_session_sm(const t_bool session_core__p_dom, const constants__t_channel_i session_core__p_channel, const constants__t_channel_i session_core__p_lost_channel, const constants__t_session_i session_core__p_session)
void session_core__find_channel_to_close(t_bool *const session_core__p_has_channel_to_close, constants__t_channel_i *const session_core__p_channel_to_close)
void session_core__client_create_session_resp_sm(const constants__t_channel_i session_core__channel, const constants__t_session_i session_core__session, const constants__t_session_token_i session_core__session_token, const constants__t_msg_i session_core__create_resp_msg, t_bool *const session_core__bret)
void session_core__client_activate_session_resp_sm(const constants__t_channel_i session_core__channel, const constants__t_session_i session_core__session, const constants__t_msg_i session_core__activate_resp_msg, t_bool *const session_core__bret)
void session_core__client_secure_channel_lost_session_sm(const constants__t_channel_i session_core__p_lost_channel, const constants__t_channel_config_idx_i session_core__p_channel_config_idx)