/usr/include/yuma/ncx/xml_msg.h is in libyuma-dev 2.10-1build1.
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 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 | /*
* Copyright (c) 2008 - 2012, Andy Bierman, All Rights Reserved.
*
* 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 _H_xml_msg
#define _H_xml_msg
/* FILE: xml_msg.h
*********************************************************************
* *
* P U R P O S E *
* *
*********************************************************************
XML Message send and receive
Deals with generic namespace and xmlns optimization
and tries to keep changing the default namespace so
most nested elements do not have prefixes
Deals with the NETCONF requirement that the attributes
in <rpc> are returned in <rpc-reply> unchanged. Although
XML allows the xnmlns prefixes to change, the same prefixes
are used in the <rpc-reply> that the NMS provided in the <rpc>.
*********************************************************************
* *
* C H A N G E H I S T O R Y *
* *
*********************************************************************
date init comment
----------------------------------------------------------------------
14-jan-07 abb Begun; split from agt_rpc.h
*/
#ifndef _H_ncxtypes
#include "ncxtypes.h"
#endif
#ifndef _H_status
#include "status.h"
#endif
#ifndef _H_val
#include "val.h"
#endif
#ifndef _H_xmlns
#include "xmlns.h"
#endif
#ifndef _H_xml_util
#include "xml_util.h"
#endif
#ifdef __cplusplus
extern "C" {
#endif
/********************************************************************
* *
* C O N S T A N T S *
* *
*********************************************************************/
/********************************************************************
* *
* T Y P E S *
* *
*********************************************************************/
/* Common XML Message Header */
typedef struct xml_msg_hdr_t_ {
/* incoming:
* All the namespace decls that were in the <rpc>
* request are used in the <rpc-reply>, so the same prefixes
* will be used, and the XML on the wire will be easier to debug
* by examining packet traces
*
* if useprefix=TRUE then prefixes will be used for
* element start and end tags. FALSE then default NS
* will be used so no prefixes will be needed except
* for XML content
*/
boolean useprefix;
ncx_withdefaults_t withdef; /* with-defaults value */
dlq_hdr_t prefixQ; /* Q of xmlns_pmap_t */
dlq_hdr_t errQ; /* Q of rpc_err_rec_t */
/* agent access control for database reads and writes;
* !!! shadow pointer to per-session cache, not malloced
*/
struct agt_acm_cache_t_ *acm_cache;
/* agent access control read authorization
* callback function: xml_msg_authfn_t
*/
void *acm_cbfn;
} xml_msg_hdr_t;
/* read authorization callback template */
typedef boolean (*xml_msg_authfn_t) (xml_msg_hdr_t *msg,
const xmlChar *username,
const val_value_t *val);
/********************************************************************
* *
* F U N C T I O N S *
* *
*********************************************************************/
/********************************************************************
* FUNCTION xml_msg_init_hdr
*
* Initialize a new xml_msg_hdr_t struct
*
* INPUTS:
* msg == xml_msg_hdr_t memory to initialize
* RETURNS:
* none
*********************************************************************/
extern void
xml_msg_init_hdr (xml_msg_hdr_t *msg);
/********************************************************************
* FUNCTION xml_msg_clean_hdr
*
* Clean all the memory used by the specified xml_msg_hdr_t
* but do not free the struct itself
*
* INPUTS:
* msg == xml_msg_hdr_t to clean
* RETURNS:
* none
*********************************************************************/
extern void
xml_msg_clean_hdr (xml_msg_hdr_t *msg);
/********************************************************************
* FUNCTION xml_msg_get_prefix
*
* Find the namespace prefix for the specified namespace ID
* If it is not there then create one
*
* INPUTS:
* msg == message to search
* parent_nsid == parent namespace ID
* nsid == namespace ID to find
* curelem == value node for current element if available
* xneeded == pointer to xmlns needed flag output value
*
* OUTPUTS:
* *xneeded == TRUE if the prefix is new and an xmlns
* decl is needed in the element being generated
*
* RETURNS:
* pointer to prefix if found, else NULL if not found
*********************************************************************/
extern const xmlChar *
xml_msg_get_prefix (xml_msg_hdr_t *msg,
xmlns_id_t parent_nsid,
xmlns_id_t nsid,
val_value_t *curelem,
boolean *xneeded);
/********************************************************************
* FUNCTION xml_msg_get_prefix_xpath
*
* Find the namespace prefix for the specified namespace ID
* If it is not there then create one in the msg prefix map
* Always returns a prefix, instead of using a default
*
* creates a new pfixmap if needed
*
* !!! MUST BE CALLED BEFORE THE <rpc-reply> XML OUTPUT
* !!! HAS BEGUN. CANNOT BE CALLED BY OUTPUT FUNCTIONS
* !!! DURING THE <get> OR <get-config> OUTPUT GENERATION
*
* INPUTS:
* msg == message to search
* nsid == namespace ID to find
*
* RETURNS:
* pointer to prefix if found, else NULL if not found
*********************************************************************/
extern const xmlChar *
xml_msg_get_prefix_xpath (xml_msg_hdr_t *msg,
xmlns_id_t nsid);
/********************************************************************
* FUNCTION xml_msg_get_prefix_start_tag
*
* Find the namespace prefix for the specified namespace ID
* DO NOT CREATE A NEW PREFIX MAP IF IT IS NOT THERE
* does not create any pfixmap, just returns NULL if not found
*
* INPUTS:
* msg == message to search
* nsid == namespace ID to find
*
* RETURNS:
* pointer to prefix if found, else NULL if not found
*********************************************************************/
extern const xmlChar *
xml_msg_get_prefix_start_tag (xml_msg_hdr_t *msg,
xmlns_id_t nsid);
/********************************************************************
* FUNCTION xml_msg_gen_new_prefix
*
* Generate a new namespace prefix
*
* INPUTS:
* msg == message to search and generate a prefix for
* nsid == namespace ID to generate prefix for
* retbuff == address of return buffer
* buffsize == buffer size
* OUTPUTS:
* if *retbuff is NULL it will be created
* else *retbuff is filled in with the new prefix if NO_ERR
*
* RETURNS:
* status
*********************************************************************/
extern status_t
xml_msg_gen_new_prefix (xml_msg_hdr_t *msg,
xmlns_id_t nsid,
xmlChar **retbuff,
uint32 buffsize);
/********************************************************************
* FUNCTION xml_msg_build_prefix_map
*
* Build a queue of xmlns_pmap_t records for the current message
*
* INPUTS:
* msg == message in progrss
* attrs == the top-level attrs list (e;g, rpc_in_attrs)
* addncid == TRUE if a prefix entry for the NC namespace
* should be added
* == FALSE if the NC nsid should not be added
* addncxid == TRUE if a prefix entry for the NCX namespace
* should be added
* == FALSE if the NCX nsid should not be added
* OUTPUTS:
* msg->prefixQ will be populated as needed,
* could be partially populated if some error returned
*
* XMLNS Entries for NETCONF and NCX will be added if they
* are not present
*
* RETURNS:
* status
*********************************************************************/
extern status_t
xml_msg_build_prefix_map (xml_msg_hdr_t *msg,
xml_attrs_t *attrs,
boolean addncid,
boolean addncxid);
/********************************************************************
* FUNCTION xml_msg_finish_prefix_map
*
* Finish the queue of xmlns_pmap_t records for the current message
*
* INPUTS:
* msg == message in progrss
* attrs == the top-level attrs list (e;g, rpc_in_attrs)
* OUTPUTS:
* msg->prefixQ will be populated as needed,
* could be partially populated if some error returned
*
* RETURNS:
* status
*********************************************************************/
extern status_t
xml_msg_finish_prefix_map (xml_msg_hdr_t *msg,
xml_attrs_t *attrs);
/********************************************************************
* FUNCTION xml_msg_check_xmlns_attr
*
* Check the default NS and the prefix map in the msg;
*
* INPUTS:
* msg == message in progress
* nsid == namespace ID to check
* badns == namespace URI of the bad namespace
* used if the nsid is the INVALID marker
* attrs == Q to hold the xml_attr_t, if generated
*
* OUTPUTS:
* msg->prefixQ will be populated as needed,
* could be partially populated if some error returned
*
* XMLNS attr entry may be added to the attrs Q
*
* RETURNS:
* status
*********************************************************************/
extern status_t
xml_msg_check_xmlns_attr (xml_msg_hdr_t *msg,
xmlns_id_t nsid,
const xmlChar *badns,
xml_attrs_t *attrs);
/********************************************************************
* FUNCTION xml_msg_gen_xmlns_attrs
*
* Generate any xmlns directives in the top-level
* attribute Q
*
* INPUTS:
* msg == message in progress
* attrs == xmlns_attrs_t Q to process
* addncx == TRUE if an xmlns for the NCX prefix (for errors)
* should be added to the <rpc-reply> element
* FALSE if not
*
* OUTPUTS:
* *attrs will be populated as needed,
*
* RETURNS:
* status
*********************************************************************/
extern status_t
xml_msg_gen_xmlns_attrs (xml_msg_hdr_t *msg,
xml_attrs_t *attrs,
boolean addncx);
/********************************************************************
* FUNCTION xml_msg_clean_defns_attr
*
* Get rid of an xmlns=foo default attribute
*
* INPUTS:
* attrs == xmlns_attrs_t Q to process
*
* OUTPUTS:
* *attrs will be cleaned as needed,
*
* RETURNS:
* status
*********************************************************************/
extern status_t
xml_msg_clean_defns_attr (xml_attrs_t *attrs);
#ifdef __cplusplus
} /* end extern 'C' */
#endif
#endif /* _H_xml_msg */
|