CPE Dictionary
[CPE]

Data Structures

struct  cpe_dict_check
 Structure representing single CPE check. More...
struct  cpe_dict_reference
 CPE dictionary item reference. More...
struct  cpe_dictitem
 Structure representing single CPE dictionary item. More...
struct  cpe_dict
 Structure representing a CPE dictionary. More...
struct  cpe_dictitem_iterator
 Iterator over CPE dictionary items. More...
struct  cpe_dict_reference_iterator
 Iterator over CPE dictionary references. More...
struct  cpe_dict_check_iterator
 Iterator over CPE dictionary checks. More...

Files

file  cpedict.h
 

Interface to Common Platform Enumeration (CPE) Dictionary.


Functions

struct cpe_dictitemcpe_dictitem_iterator::cpe_dictitem_iterator_next (struct cpe_dictitem_iterator *it)
bool cpe_dictitem_iterator::cpe_dictitem_iterator_has_more (struct cpe_dictitem_iterator *it)
void cpe_dictitem_iterator::cpe_dictitem_iterator_free (struct cpe_dictitem_iterator *it)
struct cpe_dict_referencecpe_dict_reference_iterator::cpe_dict_reference_iterator_next (struct cpe_dict_reference_iterator *it)
bool cpe_dict_reference_iterator::cpe_dict_reference_iterator_has_more (struct cpe_dict_reference_iterator *it)
void cpe_dict_reference_iterator::cpe_dict_reference_iterator_free (struct cpe_dict_reference_iterator *it)
struct cpe_dict_checkcpe_dict_check_iterator::cpe_dict_check_iterator_next (struct cpe_dict_check_iterator *it)
bool cpe_dict_check_iterator::cpe_dict_check_iterator_has_more (struct cpe_dict_check_iterator *it)
void cpe_dict_check_iterator::cpe_dict_check_iterator_free (struct cpe_dict_check_iterator *it)
struct cpe_dictcpe_dict::cpe_dict_new (const char *fname)
 Load new CPE dictionary from file.
struct cpe_dictcpe_dict::cpe_dict_new_empty (void)
 Create new empty CPE dictionary.
bool cpe_dict::cpe_dict_add_item (struct cpe_dict *dict, struct cpe_dictitem *item)
 Add item to dictionary dict.
void cpe_dict::cpe_dict_free (struct cpe_dict *dict)
 Frees CPE dictionary and its contents.
struct cpe_dictitem_iteratorcpe_dict::cpe_dict_get_items (const struct cpe_dict *item)
 Get an iterator to the dictionary contents.
const char * cpe_dict::cpe_dict_get_generator_product_name (const struct cpe_dict *item)
 Get name of a generator of the dictionary.
const char * cpe_dict::cpe_dict_get_generator_product_version (const struct cpe_dict *item)
 Get version of a generator of the dictionary.
const char * cpe_dict::cpe_dict_get_generator_schema_version (const struct cpe_dict *item)
 Get CPE dictionary schema version used to create this dictionary.
const char * cpe_dict::cpe_dict_get_generator_timestamp (const struct cpe_dict *item)
 Get timestamp of the dictionary creation.
const char * cpe_dict_check::cpe_dict_check_get_system (const struct cpe_dict_check *item)
 Get name of a checking system of the CPE check.
const char * cpe_dict_check::cpe_dict_check_get_href (const struct cpe_dict_check *item)
 Get URL of the CPE check.
const char * cpe_dict_check::cpe_dict_check_get_identifier (const struct cpe_dict_check *item)
 Get identifier of the CPE check.
const char * cpe_dict_reference::cpe_dict_reference_get_href (const struct cpe_dict_reference *item)
 Get URL of the CPE dictionary reference.
const char * cpe_dict_reference::cpe_dict_reference_get_content (const struct cpe_dict_reference *item)
 Get content of the CPE dictionary reference.
struct cpe_namecpe_dictitem::cpe_dictitem_get_name (const struct cpe_dictitem *item)
 Get CPE name of the dictionary entry.
const char * cpe_dictitem::cpe_dictitem_get_title (const struct cpe_dictitem *item)
 Get title of the dictionary entry.
struct
cpe_dict_reference_iterator
cpe_dictitem::cpe_dictitem_get_references (const struct cpe_dictitem *item)
 Get an iterator to the dictionary entry's references.
struct cpe_dict_check_iteratorcpe_dictitem::cpe_dictitem_get_checks (const struct cpe_dictitem *item)
 Get an iterator to the dictionary entry's checks.
struct oscap_string_iteratorcpe_dictitem::cpe_dictitem_get_notes (const struct cpe_dictitem *item)
 Get an iterator to the dictionary entry's notes.
struct cpe_namecpe_dictitem::cpe_dictitem_get_deprecated (const struct cpe_dictitem *item)
 Get CPE name of item that deprecated this one.
const char * cpe_dictitem::cpe_dictitem_get_deprecation_date (const struct cpe_dictitem *item)
 Get date this item was deprecated.
bool cpe_dict::cpe_name_match_dict (struct cpe_name *cpe, struct cpe_dict *dict)
 Verify wether given CPE is known according to specified dictionary.
bool cpe_dict::cpe_name_match_dict_str (const char *cpe, struct cpe_dict *dict)
 Verify if CPE given by string is known according to specified dictionary.

Function Documentation

bool cpe_dict_add_item ( struct cpe_dict dict,
struct cpe_dictitem item 
) [related, inherited]

Add item to dictionary dict.

Note:
The item will be deleted as soon as you call cpe_dict_free on the dictionary.
Parameters:
dict dictionary to add new item to
item pointer to item to add
Returns:
true on success
void cpe_dict_check_iterator_free ( struct cpe_dict_check_iterator it  )  [related, inherited]
bool cpe_dict_check_iterator_has_more ( struct cpe_dict_check_iterator it  )  [related, inherited]
struct cpe_dict_check * cpe_dict_check_iterator_next ( struct cpe_dict_check_iterator it  )  [related, inherited]
void cpe_dict_free ( struct cpe_dict dict  )  [related, inherited]

Frees CPE dictionary and its contents.

Parameters:
dict dictionary to be deleted
struct cpe_dict * cpe_dict_new ( const char *  fname  )  [related, inherited]

Load new CPE dictionary from file.

Parameters:
fname file name of dictionary to load
Returns:
new dictionary
Return values:
NULL on failure
struct cpe_dict * cpe_dict_new_empty ( void   )  [related, inherited]

Create new empty CPE dictionary.

Returns:
new dictionary
Return values:
NULL on failure
void cpe_dict_reference_iterator_free ( struct cpe_dict_reference_iterator it  )  [related, inherited]
bool cpe_dict_reference_iterator_has_more ( struct cpe_dict_reference_iterator it  )  [related, inherited]
struct cpe_dict_reference * cpe_dict_reference_iterator_next ( struct cpe_dict_reference_iterator it  )  [related, inherited]
struct cpe_name * cpe_dictitem_get_deprecated ( const struct cpe_dictitem item  )  [related, inherited]

Get CPE name of item that deprecated this one.

Return values:
NULL if the item has not been deprecated
void cpe_dictitem_iterator_free ( struct cpe_dictitem_iterator it  )  [related, inherited]
bool cpe_dictitem_iterator_has_more ( struct cpe_dictitem_iterator it  )  [related, inherited]
struct cpe_dictitem * cpe_dictitem_iterator_next ( struct cpe_dictitem_iterator it  )  [related, inherited]
bool cpe_name_match_dict ( struct cpe_name cpe,
struct cpe_dict dict 
) [related, inherited]

Verify wether given CPE is known according to specified dictionary.

Parameters:
cpe CPE to verify
dict used CPE dictionary
Returns:
true if dictionary contains given CPE
bool cpe_name_match_dict_str ( const char *  cpe,
struct cpe_dict dict 
) [related, inherited]

Verify if CPE given by string is known according to specified dictionary.

Parameters:
cpe CPE to verify
dict used CPE dictionary
Returns:
true if dictionary contains given CPE

Generated on 29 Sep 2009 for Open SCAP Library by  doxygen 1.6.1