/usr/include/rampart-1.3.0/secconv_security_context_token.h is in librampart-dev 1.3.0-1ubuntu5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 | /*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef SECCONV_SECURITY_CONTEXT_TOKEN_H
#define SECCONV_SECURITY_CONTEXT_TOKEN_H
/**
* @file secconv_security_context_token.h
* @brief security context token
*/
#include <stdio.h>
#include <stdlib.h>
#include <axutil_utils.h>
#include <axutil_string.h>
#include <oxs_buffer.h>
#ifdef __cplusplus
extern "C"
{
#endif
typedef struct security_context_token_t security_context_token_t;
/**
* Creates security context token
* @param env Pointer to environment struct
* @returns Security context token if success. NULL otherwise.
*/
AXIS2_EXTERN security_context_token_t *AXIS2_CALL
security_context_token_create(
const axutil_env_t * env);
/**
* Free security context token
* @param sct Pointer to secuirty context token struct
* @param env Pointer to environment struct
* @returns AXIS2_SUCCESS if success. AXIS2_FAILURE otherwise.
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
security_context_token_free(
security_context_token_t *sct,
const axutil_env_t *env);
/**
* Get shared secret from security context token. Callers should not free returned buffer
* @param sct Pointer to secuirty context token struct
* @param env Pointer to environment struct
* @returns shared secret if success. NULL otherwise.
*/
AXIS2_EXTERN oxs_buffer_t *AXIS2_CALL
security_context_token_get_secret(
security_context_token_t * sct,
const axutil_env_t * env);
/**
* Get global id of security context token.
* This id will be used when token is not included in the message
* @param sct Pointer to secuirty context token struct
* @param env Pointer to environment struct
* @returns global id if success. NULL otherwise.
*/
AXIS2_EXTERN axis2_char_t *AXIS2_CALL
security_context_token_get_global_identifier(
security_context_token_t * sct,
const axutil_env_t * env);
/**
* Get local id of security context token.
* This id will be used when token is included in the message
* @param sct Pointer to secuirty context token struct
* @param env Pointer to environment struct
* @returns local id if success. NULL otherwise.
*/
AXIS2_EXTERN axis2_char_t *AXIS2_CALL
security_context_token_get_local_identifier(
security_context_token_t * sct,
const axutil_env_t * env);
/**
* Set shared secret of security context token. After this method is called, ownership of
* the buffer will be with security context token. Users should not free it.
* @param sct Pointer to secuirty context token struct
* @param env Pointer to environment struct
* @param buffer Pointer to shared secret
* @returns AXIS2_SUCCESS if success. AXIS2_FAILURE otherwise.
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
security_context_token_set_secret(
security_context_token_t * sct,
const axutil_env_t * env,
oxs_buffer_t *buffer);
/**
* Set global identifier of security context token. After this method is called, ownership of
* global_id will be with security context token. Users should not free it.
* @param sct Pointer to secuirty context token struct
* @param env Pointer to environment struct
* @param global_id Global identifier of security context token
* @returns AXIS2_SUCCESS if success. AXIS2_FAILURE otherwise.
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
security_context_token_set_global_identifier(
security_context_token_t * sct,
const axutil_env_t * env,
axis2_char_t *global_id);
/**
* Set local identifier of security context token. After this method is called, ownership of
* local_id will be with security context token. Users should not free it.
* @param sct Pointer to secuirty context token struct
* @param env Pointer to environment struct
* @param local_id Local identifier of security context token
* @returns AXIS2_SUCCESS if success. AXIS2_FAILURE otherwise.
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
security_context_token_set_local_identifier(
security_context_token_t * sct,
const axutil_env_t * env,
axis2_char_t *local_id);
/**
* Set WS-SecureConversation version
* @param sct Pointer to secuirty context token struct
* @param env Pointer to environment struct
* @param is_sc10 Boolean denoting whether we need security context token as in WS-SecConv 1.0
* @returns AXIS2_SUCCESS if success. AXIS2_FAILURE otherwise.
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
security_context_token_set_is_sc10(
security_context_token_t *sct,
const axutil_env_t * env,
axis2_bool_t is_sc10);
/**
* Get shared secret as axiom_node. Shared secret will be included inside
* 'RequestedProofToken' node. This is acording to WS-Trust specification
* @param sct Pointer to secuirty context token struct
* @param env Pointer to environment struct
* @returns valid axiom_node if success. NULL otherwise.
*/
AXIS2_EXTERN axiom_node_t *AXIS2_CALL
security_context_token_get_requested_proof_token(
security_context_token_t *sct,
const axutil_env_t * env);
/**
* Get local id of security context token as axiom node.
* This id will be used when token is included in the message
* @param sct Pointer to secuirty context token struct
* @param env Pointer to environment struct
* @returns valid axiom node if success. NULL otherwise.
*/
AXIS2_EXTERN axiom_node_t *AXIS2_CALL
security_context_token_get_attached_reference(
security_context_token_t *sct,
const axutil_env_t * env);
/**
* Get global id of security context token as axiom node.
* This id will be used when token is not included in the message
* @param sct Pointer to secuirty context token struct
* @param env Pointer to environment struct
* @returns valid axiom node if success. NULL otherwise.
*/
AXIS2_EXTERN axiom_node_t *AXIS2_CALL
security_context_token_get_unattached_reference(
security_context_token_t *sct,
const axutil_env_t * env);
/**
* Get axiom node representation of security context token.
* This will be included in the message if the token needs to be sent in the message
* @param sct Pointer to secuirty context token struct
* @param env Pointer to environment struct
* @returns valid axiom node if success. NULL otherwise.
*/
AXIS2_EXTERN axiom_node_t *AXIS2_CALL
security_context_token_get_token(
security_context_token_t *sct,
const axutil_env_t * env);
/**
* Set shared secret of security context token from proof token. This proof token will be given
* by STS.
* @param sct Pointer to secuirty context token struct
* @param env Pointer to environment struct
* @param node Pointer to proof token axiom node
* @returns AXIS2_SUCCESS if success. AXIS2_FAILURE otherwise.
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
security_context_token_set_requested_proof_token(
security_context_token_t *sct,
const axutil_env_t * env,
axiom_node_t *node);
/**
* Set local identifier of security context token from attached reference node.
* @param sct Pointer to secuirty context token struct
* @param env Pointer to environment struct
* @param node Pointer to attached reference axiom node
* @returns AXIS2_SUCCESS if success. AXIS2_FAILURE otherwise.
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
security_context_token_set_attached_reference(
security_context_token_t *sct,
const axutil_env_t * env,
axiom_node_t *node);
/**
* Set global identifier of security context token from unattached reference node.
* @param sct Pointer to secuirty context token struct
* @param env Pointer to environment struct
* @param node Pointer to unattached reference axiom node
* @returns AXIS2_SUCCESS if success. AXIS2_FAILURE otherwise.
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
security_context_token_set_unattached_reference(
security_context_token_t *sct,
const axutil_env_t * env,
axiom_node_t *node);
/**
* Set axiom representation of security context token
* @param sct Pointer to secuirty context token struct
* @param env Pointer to environment struct
* @param node Pointer to security context token axiom node
* @returns AXIS2_SUCCESS if success. AXIS2_FAILURE otherwise.
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
security_context_token_set_token(
security_context_token_t *sct,
const axutil_env_t * env,
axiom_node_t *node);
/**
* Increment the reference of security context token
* @param sct Pointer to secuirty context token struct
* @param env Pointer to environment struct
* @returns AXIS2_SUCCESS if success. AXIS2_FAILURE otherwise.
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
security_context_token_increment_ref(
security_context_token_t *sct,
const axutil_env_t * env);
/**
* Serializes the security context token. Caller should take the ownership of returned value
* @param sct Pointer to secuirty context token struct
* @param env Pointer to environment struct
* @returns serialized security context token if success. NULL otherwise
*/
AXIS2_EXTERN axis2_char_t * AXIS2_CALL
security_context_token_serialize(
security_context_token_t *sct,
const axutil_env_t *env);
/**
* Deserializes the security context token.
* @param sct Pointer to secuirty context token struct
* @param env Pointer to environment struct
* @param serialised_node serialised string representation of security context token
* @returns serialized security context token if success. NULL otherwise
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
security_context_token_deserialize(
security_context_token_t *sct,
const axutil_env_t *env,
axis2_char_t *serialised_node);
#ifdef __cplusplus
}
#endif
#endif /*SECCONV_SECURITY_CONTEXT_TOKEN_H */
|