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
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Open SCAP Library: OVALAGENT</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>OVALAGENT<br/>
<small>
[<a class="el" href="group__OVAL.html">OVAL</a>]</small>
</h1>
<p>OVAL Agent interface.
<a href="#_details">More...</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Data Structures</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structoval__agent__cb__data.html">oval_agent_cb_data</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Handle all callback data that are needed by xccdf_policy_eval_rule_cb_t. <a href="structoval__agent__cb__data.html#_details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2>Files</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">file </td><td class="memItemRight" valign="bottom"><a class="el" href="oval__agent__api_8h.html">oval_agent_api.h</a></td></tr>
<tr><td colspan="2"><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga7c852f3681ee4aaf6d372facf2e8c016"></a><!-- doxytag: member="OVALAGENT::oval_agent_session_t" ref="ga7c852f3681ee4aaf6d372facf2e8c016" args="" -->
typedef struct <a class="el" href="structoval__agent__session.html">oval_agent_session</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALAGENT.html#ga7c852f3681ee4aaf6d372facf2e8c016">oval_agent_session_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Agent session consists of connection to system checking engine, definition model, system characteristics model and results model. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef int( </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALAGENT.html#gaf161e671e9cd718f3231044b24b15e86">oval_agent_result_cb_t</a> )(const char *id, int result, void *arg)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This callback is called after evaluation of each definition. <a href="#gaf161e671e9cd718f3231044b24b15e86"></a><br/></td></tr>
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga063cbd39becb1e6848966ad88f48de51"></a><!-- doxytag: member="OVALAGENT::oval_agent_new_session" ref="ga063cbd39becb1e6848966ad88f48de51" args="(struct oval_definition_model *model)" -->
<a class="el" href="structoval__agent__session.html">oval_agent_session_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALAGENT.html#ga063cbd39becb1e6848966ad88f48de51">oval_agent_new_session</a> (struct <a class="el" href="structoval__definition__model.html">oval_definition_model</a> *model)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create new session for OVAL agent from OVAL definition model. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga65c6c0a750c30ccbf40aea8e2e3f4374"></a><!-- doxytag: member="OVALAGENT::oval_agent_eval_definition" ref="ga65c6c0a750c30ccbf40aea8e2e3f4374" args="(oval_agent_session_t *ag_sess, const char *id)" -->
<a class="el" href="group__OVALRES.html#ga585abe0825db03426e1994ba335dc4bf">oval_result_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALAGENT.html#ga65c6c0a750c30ccbf40aea8e2e3f4374">oval_agent_eval_definition</a> (<a class="el" href="structoval__agent__session.html">oval_agent_session_t</a> *ag_sess, const char *id)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Probe the system and evaluate specified definition. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga1b0b775e52aff1452ff4423f897c5825"></a><!-- doxytag: member="OVALAGENT::oval_agent_reset_session" ref="ga1b0b775e52aff1452ff4423f897c5825" args="(oval_agent_session_t *ag_sess)" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALAGENT.html#ga1b0b775e52aff1452ff4423f897c5825">oval_agent_reset_session</a> (<a class="el" href="structoval__agent__session.html">oval_agent_session_t</a> *ag_sess)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clean resuls that were generated in this agent session. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaec71f72c60b8c668f270c8c85cbf640a"></a><!-- doxytag: member="OVALAGENT::oval_agent_eval_system" ref="gaec71f72c60b8c668f270c8c85cbf640a" args="(oval_agent_session_t *ag_sess, oval_agent_result_cb_t *cb, void *arg)" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALAGENT.html#gaec71f72c60b8c668f270c8c85cbf640a">oval_agent_eval_system</a> (<a class="el" href="structoval__agent__session.html">oval_agent_session_t</a> *ag_sess, <a class="el" href="group__OVALAGENT.html#gaf161e671e9cd718f3231044b24b15e86">oval_agent_result_cb_t</a> *cb, void *arg)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Probe and evaluate all definitions from the content, call the callback functions upon single evaluation. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga46b7afeb2b281141e4722f219a7a438a"></a><!-- doxytag: member="OVALAGENT::oval_agent_get_results_model" ref="ga46b7afeb2b281141e4722f219a7a438a" args="(oval_agent_session_t *ag_sess)" -->
struct <a class="el" href="structoval__results__model.html">oval_results_model</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALAGENT.html#ga46b7afeb2b281141e4722f219a7a438a">oval_agent_get_results_model</a> (<a class="el" href="structoval__agent__session.html">oval_agent_session_t</a> *ag_sess)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a result model from agent session. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga301f466948c1844837208f917b3e2025"></a><!-- doxytag: member="OVALAGENT::oval_agent_destroy_session" ref="ga301f466948c1844837208f917b3e2025" args="(oval_agent_session_t *ag_sess)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALAGENT.html#ga301f466948c1844837208f917b3e2025">oval_agent_destroy_session</a> (<a class="el" href="structoval__agent__session.html">oval_agent_session_t</a> *ag_sess)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Finish OVAL agent session. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structoval__agent__cb__data.html">oval_agent_cb_data</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALAGENT.html#gaaeeaddad8cd993de2022553ed94b9ae0">oval_agent_cb_data::oval_agent_cb_data_new</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create new OVAL Agent callback data. <a href="#gaaeeaddad8cd993de2022553ed94b9ae0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALAGENT.html#ga038c2e9ec791d86a6db76301de4628ac">oval_agent_cb_data::oval_agent_cb_data_free</a> (struct <a class="el" href="structoval__agent__cb__data.html">oval_agent_cb_data</a> *data)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Free function of OVAL Agent callback data. <a href="#ga038c2e9ec791d86a6db76301de4628ac"></a><br/></td></tr>
<tr><td colspan="2"><h2>Evaluators</h2></td></tr>
<tr><td colspan="2"><p><a class="anchor" id="amgrp1fdbbbb8aba6580be2c9cb4b12e86ca2"></a> </p>
<br/><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="group__XCCDF.html#gabf34f4480799efc8e1af5f4706d2666d">xccdf_test_result_type_t</a>( </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALAGENT.html#gaa4616a7375ac4a91ee293d69a5c30481">xccdf_policy_eval_rule_cb_t</a> )(struct <a class="el" href="structxccdf__policy.html">xccdf_policy</a> *policy, const char *rule_id, const char *id, struct xccdf_value_binding_iterator *it, void *usr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__XCCDF.html#gabf34f4480799efc8e1af5f4706d2666d">xccdf_test_result_type_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALAGENT.html#ga7b472f8a251a294478a01bbf96417bf7">oval_agent_eval_rule</a> (struct <a class="el" href="structxccdf__policy.html">xccdf_policy</a> *policy, const char *rule_id, const char *id, struct xccdf_value_binding_iterator *it, void *usr)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Internal OVAL Agent Callback that can be used to evaluate XCCDF content. <a href="#ga7b472f8a251a294478a01bbf96417bf7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALAGENT.html#ga9020215fc2db19ea98b6e11984947176">oval_agent_resolve_variables</a> (struct <a class="el" href="structoval__agent__session.html">oval_agent_session</a> *session, struct xccdf_value_binding_iterator *it)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Resolve variables from XCCDF Value Bindings and set their values to OVAL Variables. <a href="#ga9020215fc2db19ea98b6e11984947176"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALAGENT.html#gacd87da61a584f365001a6a9a1f4a5c13">oval_agent_export_sysinfo_to_xccdf_result</a> (struct <a class="el" href="structoval__agent__session.html">oval_agent_session</a> *session, struct <a class="el" href="structxccdf__result.html">xccdf_result</a> *ritem)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Transform OVAL Sysinfo into XCCDF Test Result. <a href="#gacd87da61a584f365001a6a9a1f4a5c13"></a><br/></td></tr>
<tr><td colspan="2"><h2>Getters</h2></td></tr>
<tr><td colspan="2"><p><a class="anchor" id="amgrpc9fd0bcb5385a65354c37f1bb504399d"></a>Return value is pointer to structure's member.</p>
<p>Do not free unless you null the pointer in the structure. Use remove function otherwise. </p>
<br/><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structoval__agent__session.html">oval_agent_session</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALAGENT.html#ga8798934771d02532822073e5e6d09e66">oval_agent_cb_data::oval_agent_cb_data_get_session</a> (const struct <a class="el" href="structoval__agent__cb__data.html">oval_agent_cb_data</a> *data)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get session of OVAL Agent callback data. <a href="#ga8798934771d02532822073e5e6d09e66"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__OVALAGENT.html#gaf161e671e9cd718f3231044b24b15e86">oval_agent_result_cb_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALAGENT.html#ga1589810dcfaa46fd942c38deac774491">oval_agent_cb_data::oval_agent_cb_data_get_callback</a> (const struct <a class="el" href="structoval__agent__cb__data.html">oval_agent_cb_data</a> *data)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get callback of OVAL Agent callback data. <a href="#ga1589810dcfaa46fd942c38deac774491"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALAGENT.html#ga6e328a4a69868d36c89a3f031583f060">oval_agent_cb_data::oval_agent_cb_data_get_usr</a> (const struct <a class="el" href="structoval__agent__cb__data.html">oval_agent_cb_data</a> *data)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get usr data of OVAL Agent callback data. <a href="#ga6e328a4a69868d36c89a3f031583f060"></a><br/></td></tr>
<tr><td colspan="2"><h2>Setters</h2></td></tr>
<tr><td colspan="2"><p><a class="anchor" id="amgrp6e47466b75bb957a603aa54c079ac8bf"></a>For lists use add functions.</p>
<p>Parameters of set functions are duplicated in memory and need to be freed by caller. </p>
<br/><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALAGENT.html#ga9b77bd4bf6988b3e2061677f3b0a12b8">oval_agent_cb_data::oval_agent_cb_data_set_session</a> (struct <a class="el" href="structoval__agent__cb__data.html">oval_agent_cb_data</a> *data, struct <a class="el" href="structoval__agent__session.html">oval_agent_session</a> *session)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the OVAL Agent session to OVAL Agent callback data. <a href="#ga9b77bd4bf6988b3e2061677f3b0a12b8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALAGENT.html#ga7bd156f921b42c01e68323683729dbb4">oval_agent_cb_data::oval_agent_cb_data_set_callback</a> (struct <a class="el" href="structoval__agent__cb__data.html">oval_agent_cb_data</a> *data, <a class="el" href="group__OVALAGENT.html#gaf161e671e9cd718f3231044b24b15e86">oval_agent_result_cb_t</a> *<a class="el" href="structcallback__t.html">callback</a>, void *usr)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the OVAL Agent Result callback to OVAL Agent callback data. <a href="#ga7bd156f921b42c01e68323683729dbb4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALAGENT.html#gab4cf4016cf92228faea70c65a3a7b873">oval_agent_cb_data::oval_agent_cb_data_set_usr</a> (struct <a class="el" href="structoval__agent__cb__data.html">oval_agent_cb_data</a> *data, void *usr)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the User data to OVAL Agent callback data. <a href="#gab4cf4016cf92228faea70c65a3a7b873"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>OVAL Agent interface. </p>
<p>This is a high level API for system probing and OVAL Definition content evaluation. </p>
<hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="gaf161e671e9cd718f3231044b24b15e86"></a><!-- doxytag: member="oval_agent_api.h::oval_agent_result_cb_t" ref="gaf161e671e9cd718f3231044b24b15e86" args=")(const char *id, int result, void *arg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__OVALAGENT.html#gaf161e671e9cd718f3231044b24b15e86">oval_agent_result_cb_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This callback is called after evaluation of each definition. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>definition id that was evaluated </td></tr>
<tr><td valign="top"></td><td valign="top"><em>result</em> </td><td>definition result </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gaa4616a7375ac4a91ee293d69a5c30481"></a><!-- doxytag: member="oval_agent_api.h::xccdf_policy_eval_rule_cb_t" ref="gaa4616a7375ac4a91ee293d69a5c30481" args=")(struct xccdf_policy *policy, const char *rule_id, const char *id, struct xccdf_value_binding_iterator *it, void *usr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="group__XCCDF.html#gabf34f4480799efc8e1af5f4706d2666d">xccdf_test_result_type_t</a>( <a class="el" href="group__OVALAGENT.html#gaa4616a7375ac4a91ee293d69a5c30481">xccdf_policy_eval_rule_cb_t</a>)(struct <a class="el" href="structxccdf__policy.html">xccdf_policy</a> *policy, const char *rule_id, const char *id, struct xccdf_value_binding_iterator *it, void *usr)</td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>policy</em> </td><td>XCCDF Policy that is being evaluated </td></tr>
<tr><td valign="top"></td><td valign="top"><em>rule_id</em> </td><td>ID of XCCDF Rule </td></tr>
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>ID of OVAL definition </td></tr>
<tr><td valign="top"></td><td valign="top"><em>it</em> </td><td>XCCDF Value Binding iterator with value bindings </td></tr>
<tr><td valign="top"></td><td valign="top"><em>usr</em> </td><td>Void pointer to the user data structure </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>XCCDF test result type of evaluated rule </dd></dl>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga038c2e9ec791d86a6db76301de4628ac"></a><!-- doxytag: member="oval_agent_cb_data::oval_agent_cb_data_free" ref="ga038c2e9ec791d86a6db76301de4628ac" args="(struct oval_agent_cb_data *data)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void oval_agent_cb_data_free </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structoval__agent__cb__data.html">oval_agent_cb_data</a> * </td>
<td class="paramname"> <em>data</em></td>
<td> ) </td>
<td><code> [inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Free function of OVAL Agent callback data. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>OVAL Agent callback data </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga1589810dcfaa46fd942c38deac774491"></a><!-- doxytag: member="oval_agent_cb_data::oval_agent_cb_data_get_callback" ref="ga1589810dcfaa46fd942c38deac774491" args="(const struct oval_agent_cb_data *data)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__OVALAGENT.html#gaf161e671e9cd718f3231044b24b15e86">oval_agent_result_cb_t</a> * oval_agent_cb_data_get_callback </td>
<td>(</td>
<td class="paramtype">const struct <a class="el" href="structoval__agent__cb__data.html">oval_agent_cb_data</a> * </td>
<td class="paramname"> <em>data</em></td>
<td> ) </td>
<td><code> [inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get callback of OVAL Agent callback data. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>OVAL Agent callback data</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>oval_agent_result_cb_t callback </dd></dl>
</div>
</div>
<a class="anchor" id="ga8798934771d02532822073e5e6d09e66"></a><!-- doxytag: member="oval_agent_cb_data::oval_agent_cb_data_get_session" ref="ga8798934771d02532822073e5e6d09e66" args="(const struct oval_agent_cb_data *data)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structoval__agent__session.html">oval_agent_session</a> * oval_agent_cb_data_get_session </td>
<td>(</td>
<td class="paramtype">const struct <a class="el" href="structoval__agent__cb__data.html">oval_agent_cb_data</a> * </td>
<td class="paramname"> <em>data</em></td>
<td> ) </td>
<td><code> [read, inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get session of OVAL Agent callback data. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>OVAL Agent callback data</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="structoval__agent__session.html">oval_agent_session</a> structure </dd></dl>
</div>
</div>
<a class="anchor" id="ga6e328a4a69868d36c89a3f031583f060"></a><!-- doxytag: member="oval_agent_cb_data::oval_agent_cb_data_get_usr" ref="ga6e328a4a69868d36c89a3f031583f060" args="(const struct oval_agent_cb_data *data)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void * oval_agent_cb_data_get_usr </td>
<td>(</td>
<td class="paramtype">const struct <a class="el" href="structoval__agent__cb__data.html">oval_agent_cb_data</a> * </td>
<td class="paramname"> <em>data</em></td>
<td> ) </td>
<td><code> [inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get usr data of OVAL Agent callback data. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>OVAL Agent callback data</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>void pointer to user data structure </dd></dl>
</div>
</div>
<a class="anchor" id="gaaeeaddad8cd993de2022553ed94b9ae0"></a><!-- doxytag: member="oval_agent_cb_data::oval_agent_cb_data_new" ref="gaaeeaddad8cd993de2022553ed94b9ae0" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structoval__agent__cb__data.html">oval_agent_cb_data</a> * oval_agent_cb_data_new </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [read, inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create new OVAL Agent callback data. </p>
<dl class="user"><dt><b>Structure:</b></dt><dd><ul>
<li><a class="el" href="structoval__agent__session.html">oval_agent_session</a> </li>
<li>oval_agent_result_cb_t </li>
<li>usr </li>
</ul>
</dd></dl>
<dl class="user"><dt><b>Example</b></dt><dd><div class="fragment"><pre class="fragment"> <span class="keyword">struct </span><a class="code" href="structoval__agent__cb__data.html" title="Handle all callback data that are needed by xccdf_policy_eval_rule_cb_t.">oval_agent_cb_data</a> *<a class="code" href="structoval__agent__cb__data.html#a5f397bf6e2d379327b2c59720724f78b" title="User data passed to callback.">usr</a> = <a class="code" href="group__OVALAGENT.html#gaaeeaddad8cd993de2022553ed94b9ae0" title="Create new OVAL Agent callback data.">oval_agent_cb_data_new</a>();
<a class="code" href="group__OVALAGENT.html#ga9b77bd4bf6988b3e2061677f3b0a12b8" title="Set the OVAL Agent session to OVAL Agent callback data.">oval_agent_cb_data_set_session</a>(usr, <a class="code" href="structoval__agent__cb__data.html#a354056b9e36287cced09c26d3b5f023b" title="OVAL Agent session.">session</a>);
<a class="code" href="group__OVALAGENT.html#ga7bd156f921b42c01e68323683729dbb4" title="Set the OVAL Agent Result callback to OVAL Agent callback data.">oval_agent_cb_data_set_callback</a>(usr, <a class="code" href="structcallback__t.html" title="Typedef of callback structure with system identificator, callback function and usr...">callback</a>);
<a class="code" href="group__OVALAGENT.html#gab4cf4016cf92228faea70c65a3a7b873" title="Set the User data to OVAL Agent callback data.">oval_agent_cb_data_set_usr</a>(usr, (<span class="keywordtype">void</span> *) usr_structure);
</pre></div> </dd></dl>
</div>
</div>
<a class="anchor" id="ga7bd156f921b42c01e68323683729dbb4"></a><!-- doxytag: member="oval_agent_cb_data::oval_agent_cb_data_set_callback" ref="ga7bd156f921b42c01e68323683729dbb4" args="(struct oval_agent_cb_data *data, oval_agent_result_cb_t *callback, void *usr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool oval_agent_cb_data_set_callback </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structoval__agent__cb__data.html">oval_agent_cb_data</a> * </td>
<td class="paramname"> <em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__OVALAGENT.html#gaf161e671e9cd718f3231044b24b15e86">oval_agent_result_cb_t</a> * </td>
<td class="paramname"> <em>callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>usr</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the OVAL Agent Result callback to OVAL Agent callback data. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>Oval Agent callback data </td></tr>
<tr><td valign="top"></td><td valign="top"><em>callback</em> </td><td>OVAL Agent Result callback</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Boolean </dd></dl>
</div>
</div>
<a class="anchor" id="ga9b77bd4bf6988b3e2061677f3b0a12b8"></a><!-- doxytag: member="oval_agent_cb_data::oval_agent_cb_data_set_session" ref="ga9b77bd4bf6988b3e2061677f3b0a12b8" args="(struct oval_agent_cb_data *data, struct oval_agent_session *session)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool oval_agent_cb_data_set_session </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structoval__agent__cb__data.html">oval_agent_cb_data</a> * </td>
<td class="paramname"> <em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct <a class="el" href="structoval__agent__session.html">oval_agent_session</a> * </td>
<td class="paramname"> <em>session</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the OVAL Agent session to OVAL Agent callback data. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>Oval Agent callback data </td></tr>
<tr><td valign="top"></td><td valign="top"><em>session</em> </td><td>OVAL Agent Session</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Boolean </dd></dl>
</div>
</div>
<a class="anchor" id="gab4cf4016cf92228faea70c65a3a7b873"></a><!-- doxytag: member="oval_agent_cb_data::oval_agent_cb_data_set_usr" ref="gab4cf4016cf92228faea70c65a3a7b873" args="(struct oval_agent_cb_data *data, void *usr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool oval_agent_cb_data_set_usr </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structoval__agent__cb__data.html">oval_agent_cb_data</a> * </td>
<td class="paramname"> <em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>usr</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the User data to OVAL Agent callback data. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>Oval Agent callback data </td></tr>
<tr><td valign="top"></td><td valign="top"><em>usr</em> </td><td>User data</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Boolean </dd></dl>
</div>
</div>
<a class="anchor" id="ga7b472f8a251a294478a01bbf96417bf7"></a><!-- doxytag: member="oval_agent_api.h::oval_agent_eval_rule" ref="ga7b472f8a251a294478a01bbf96417bf7" args="(struct xccdf_policy *policy, const char *rule_id, const char *id, struct xccdf_value_binding_iterator *it, void *usr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__XCCDF.html#gabf34f4480799efc8e1af5f4706d2666d">xccdf_test_result_type_t</a> oval_agent_eval_rule </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxccdf__policy.html">xccdf_policy</a> * </td>
<td class="paramname"> <em>policy</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>rule_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct xccdf_value_binding_iterator * </td>
<td class="paramname"> <em>it</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>usr</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Internal OVAL Agent Callback that can be used to evaluate XCCDF content. </p>
<dl class="user"><dt><b>Example</b></dt><dd>Next example shows common use of this function in evaluation proccess of XCCDF file. </dd></dl>
<dl class="user"><dt><b></b></dt><dd><div class="fragment"><pre class="fragment"> <span class="keyword">struct </span><a class="code" href="structxccdf__benchmark.html" title="Top level XCCDF structure containing profiles, rules, values and results.">xccdf_benchmark</a> * benchmark = <a class="code" href="group__XCCDF.html#gad71cc690fef5bceb9aa98bed119288f0" title="Import the content from a specified XML stream into a benchmark.">xccdf_benchmark_import</a>(file);
<span class="keyword">struct </span><a class="code" href="structxccdf__policy__model.html" title="XCCDF policy model structure contains xccdf_benchmark as reference to Benchmark element...">xccdf_policy_model</a> * policy_model = <a class="code" href="group__XCCDF__POLICY.html#ga4f8f92790770ff3e12e55f3921b77261" title="Constructor of Policy Model structure.">xccdf_policy_model_new</a>(benchmark);
<span class="keyword">struct </span><a class="code" href="structoval__agent__cb__data.html" title="Handle all callback data that are needed by xccdf_policy_eval_rule_cb_t.">oval_agent_cb_data</a> * usr = <a class="code" href="group__OVALAGENT.html#gaaeeaddad8cd993de2022553ed94b9ae0" title="Create new OVAL Agent callback data.">oval_agent_cb_data_new</a>();
...
xccdf_policy_model_register_callback(policy_model, <span class="stringliteral">"http://oval.mitre.org/XMLSchema/oval-definitions-5"</span>, <a class="code" href="group__OVALAGENT.html#ga7b472f8a251a294478a01bbf96417bf7" title="Internal OVAL Agent Callback that can be used to evaluate XCCDF content.">oval_agent_eval_rule</a>, (<span class="keywordtype">void</span> *) usr);
</pre></div> </dd></dl>
</div>
</div>
<a class="anchor" id="gacd87da61a584f365001a6a9a1f4a5c13"></a><!-- doxytag: member="oval_agent_api.h::oval_agent_export_sysinfo_to_xccdf_result" ref="gacd87da61a584f365001a6a9a1f4a5c13" args="(struct oval_agent_session *session, struct xccdf_result *ritem)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void oval_agent_export_sysinfo_to_xccdf_result </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structoval__agent__session.html">oval_agent_session</a> * </td>
<td class="paramname"> <em>session</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct <a class="el" href="structxccdf__result.html">xccdf_result</a> * </td>
<td class="paramname"> <em>ritem</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Transform OVAL Sysinfo into XCCDF Test Result. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>session</em> </td><td>OVAL Agent session </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ritem</em> </td><td>XCCDF Result </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga9020215fc2db19ea98b6e11984947176"></a><!-- doxytag: member="oval_agent_api.h::oval_agent_resolve_variables" ref="ga9020215fc2db19ea98b6e11984947176" args="(struct oval_agent_session *session, struct xccdf_value_binding_iterator *it)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void oval_agent_resolve_variables </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structoval__agent__session.html">oval_agent_session</a> * </td>
<td class="paramname"> <em>session</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct xccdf_value_binding_iterator * </td>
<td class="paramname"> <em>it</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Resolve variables from XCCDF Value Bindings and set their values to OVAL Variables. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>session</em> </td><td>OVAL Agent Session </td></tr>
<tr><td valign="top"></td><td valign="top"><em>it</em> </td><td>XCCDF Value Bindng iterator </td></tr>
</table>
</dd>
</dl>
<dl class="user"><dt><b>Example</b></dt><dd>Example in <a class="el" href="oval__agent_8c.html" title="Open Vulnerability and Assessment Language.">oval_agent.c</a> in function oval_agent_eval_rule </dd></dl>
</div>
</div>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on 30 Jun 2010 for Open SCAP Library by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
|
