/usr/include/rampart-1.3.0/oxs_key.h is in librampart-dev 1.3.0-3.
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 | /*
* 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 OXS_KEY_H
#define OXS_KEY_H
/**
* @file oxs_key.h
* @brief represents a Key in OMXMLSecurity
*/
/**
* @defgroup oxs_key Key
* @ingroup oxs
* @{
*/
#include <axis2_defines.h>
#include <oxs_constants.h>
#include <oxs_buffer.h>
#include <axutil_env.h>
#include <rp_algorithmsuite.h>
#ifdef __cplusplus
extern "C"
{
#endif
/*Key usage is not specified yet*/
#define OXS_KEY_USAGE_NONE 0
/*Key is a session key */
#define OXS_KEY_USAGE_SESSION 1
/*Key is a signature session key*/
#define OXS_KEY_USAGE_SIGNATURE_SESSION 2
/*Key is a derived key */
#define OXS_KEY_USAGE_DERIVED 3
#define OXS_KEY_DEFAULT_SIZE 64
/** Type name for struct oxs_key */
typedef struct oxs_key_t oxs_key_t;
/**
* Gets data of the key.
* @param key oxs_key ptr to key
* @param env pointer to environment struct
* @return data
*/
AXIS2_EXTERN unsigned char *AXIS2_CALL
oxs_key_get_data(
const oxs_key_t *key,
const axutil_env_t *env);
/**
* Gets the name of the key.
* @param key oxs_key ptr to key
* @param env pointer to environment struct
* @return name of the key
*/
AXIS2_EXTERN axis2_char_t *AXIS2_CALL
oxs_key_get_name(
const oxs_key_t *key,
const axutil_env_t *env);
/**
* Gets the nonce of the key.
* @param key oxs_key ptr to key
* @param env pointer to environment struct
* @return nonce of the key
*/
AXIS2_EXTERN axis2_char_t *AXIS2_CALL
oxs_key_get_nonce(
const oxs_key_t *key,
const axutil_env_t *env);
/**
* Gets the label of the key.
* @param key oxs_key ptr to key
* @param env pointer to environment struct
* @return label of the key
*/
AXIS2_EXTERN axis2_char_t *AXIS2_CALL
oxs_key_get_label(
const oxs_key_t *key,
const axutil_env_t *env);
/**
* Gets the size of the key.
* @param key oxs_key ptr to key
* @param env pointer to environment struct
* @return size of the key
*/
AXIS2_EXTERN int AXIS2_CALL
oxs_key_get_size(
const oxs_key_t *key,
const axutil_env_t *env);
/**
* Gets the usage of the key.
* @param key oxs_key ptr to key
* @param env pointer to environment struct
* @return usage of the key
*/
AXIS2_EXTERN int AXIS2_CALL
oxs_key_get_usage(
const oxs_key_t *key,
const axutil_env_t *env);
/**
* Gets the offset of the key.
* @param key oxs_key ptr to key
* @param env pointer to environment struct
* @return offset of the key
*/
AXIS2_EXTERN int AXIS2_CALL
oxs_key_get_offset(
const oxs_key_t *key,
const axutil_env_t *env);
/**
* Gets the length of the key.
* @param key oxs_key ptr to key
* @param env pointer to environment struct
* @return length of the key
*/
AXIS2_EXTERN int AXIS2_CALL
oxs_key_get_length(
const oxs_key_t *key,
const axutil_env_t *env);
/**
* Sets the name of the key.
* @param key oxs_key ptr to key
* @param env pointer to environment struct
* @param name name of the key
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
oxs_key_set_name(
oxs_key_t *key,
const axutil_env_t *env,
axis2_char_t *name);
/**
* Set the usage of the key.
* @param key oxs_key ptr to key
* @param env pointer to environment struct
* @param usage usage of the key
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
oxs_key_set_usage(
oxs_key_t *key,
const axutil_env_t *env,
int usage);
AXIS2_EXTERN axis2_status_t AXIS2_CALL
oxs_key_set_nonce(
oxs_key_t *key,
const axutil_env_t *env,
axis2_char_t *nonce);
AXIS2_EXTERN axis2_status_t AXIS2_CALL
oxs_key_set_label(
oxs_key_t *key,
const axutil_env_t *env,
axis2_char_t *label);
AXIS2_EXTERN axis2_status_t AXIS2_CALL
oxs_key_set_offset(
oxs_key_t *key,
const axutil_env_t *env,
int offset);
AXIS2_EXTERN axis2_status_t AXIS2_CALL
oxs_key_set_length(
oxs_key_t *key,
const axutil_env_t *env,
int length);
/**
* Free function for key.
* @param key oxs_key ptr to key
* @param env pointer to environment struct
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
oxs_key_free(
oxs_key_t *key,
const axutil_env_t *env
);
AXIS2_EXTERN axis2_status_t AXIS2_CALL
oxs_key_populate_with_buf(oxs_key_t *key,
const axutil_env_t *env,
oxs_buffer_t *buffer,
axis2_char_t *name,
int usage);
/**
* Populate a key.
* @param key oxs_key ptr to key
* @param env pointer to environment struct
* @param data data of the key
* @param name name of the key
* @param size size of the key
* @param usage usage of the key
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
oxs_key_populate(
oxs_key_t *key,
const axutil_env_t *env,
unsigned char *data,
axis2_char_t *name,
int size,
int usage);
/**
* Read a key from a file.
* @param key oxs_key ptr to key
* @param env pointer to environment struct
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
oxs_key_read_from_file(
oxs_key_t *key,
const axutil_env_t *env,
axis2_char_t *file_name);
/**
* Fill the key for the given algo.
* @param key oxs_key ptr to key
* @param env pointer to environment struct
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
oxs_key_for_algo(oxs_key_t *key,
const axutil_env_t *env,
rp_algorithmsuite_t *key_algo);
AXIS2_EXTERN oxs_buffer_t *AXIS2_CALL
oxs_key_get_buffer(const oxs_key_t *key,
const axutil_env_t *env);
AXIS2_EXTERN oxs_key_t *AXIS2_CALL
oxs_key_dup(oxs_key_t *key,
const axutil_env_t *env);
AXIS2_EXTERN oxs_key_t *AXIS2_CALL
oxs_key_create(const axutil_env_t *env);
/* once the key_sha is given, ownership is assumed */
AXIS2_EXTERN axis2_status_t AXIS2_CALL
oxs_key_set_key_sha(
oxs_key_t *key,
const axutil_env_t *env,
axis2_char_t *key_sha);
AXIS2_EXTERN axis2_char_t *AXIS2_CALL
oxs_key_get_key_sha(
const oxs_key_t *key,
const axutil_env_t *env);
#ifdef __cplusplus
}
#endif
#endif /* OXS_KEY_H */
|