validator.h File Reference

Headers/structs for a string validator. More...

#include <glib.h>

Include dependency graph for validator.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	validator_rule
	A validator rule. More...

Typedefs
typedef GHashTable *	validator_t
	A set of name rule pairs. More...
typedef struct validator_rule	validator_rule_t
	A validator rule. More...

Functions
validator_t	openvas_validator_new ()
	Create a new validator. More...
void	openvas_validator_add (validator_t, const char *, const char *)
	Add or overwrite a validation rule. More...
int	openvas_validator_alias (validator_t, const char *, const char *)
	Make an alias for a rule name. More...
gchar *	openvas_validator_alias_for (validator_t, const char *)
	Get the name of the rule for which a rule is an alias. More...
int	openvas_validate (validator_t, const char *, const char *)
	Validate a string for a given rule. More...
void	openvas_validator_free (validator_t)
	Free a validator. More...

Detailed Description

Headers/structs for a string validator.

Definition in file validator.h.

Typedef Documentation

validator_rule_t

typedef struct validator_rule validator_rule_t

A validator rule.

Definition at line 54 of file validator.h.

validator_t

typedef GHashTable* validator_t

A set of name rule pairs.

Definition at line 40 of file validator.h.

Function Documentation

openvas_validate()

int openvas_validate	(	validator_t	validator,
		const char *	name,
		const char *	value
	)

Validate a string for a given rule.

Parameters

validator	Validator to validate from.
name	Name of rule.
value	Value to validate.

Returns

0 if valid

• value is valid, 1 if failed to find
• name in validator, 2 if value failed to match the regexp.

Definition at line 182 of file validator.c.

{
  gpointer key, value_rule;

  if (name != NULL && g_utf8_validate (name, -1, NULL) == FALSE)
    {
      g_debug ("%s: name is not valid UTF-8", __FUNCTION__);
      return 1;
    }
  else if (value != NULL && g_utf8_validate (value, -1, NULL) == FALSE)
    {
      g_debug ("%s: value is not valid UTF-8", __FUNCTION__);
      return 2;
    }

  g_debug ("%s: name %s value %s", __FUNCTION__, name, value);

  if (g_hash_table_lookup_extended (validator, name, &key, &value_rule))
    {
      validator_rule_t *rule;

      assert (value_rule);

      rule = (validator_rule_t*) value_rule;

      if (rule->regex == NULL)
        {
          if (value == NULL)
            {
              g_debug ("%s: matched, regex NULL", __FUNCTION__);
              return 0;
            }
          g_debug ("%s: failed to match, regex NULL", __FUNCTION__);
          return 2;
        }

      if (value == NULL)
        {
          g_debug ("%s: failed to match, value NULL", __FUNCTION__);
          return 2;
        }

      g_debug ("matching <%s> against <%s>: ", (char *) rule->regex, value);
      if (g_regex_match_simple (rule->regex,
                                (const gchar *) value,
                                0,
                                0))
        {
          g_debug ("%s: matched", __FUNCTION__);
          return 0;
        }
      g_debug ("%s: failed to match\n", __FUNCTION__);
      return 2;
    }

  g_debug ("%s: failed to find name: %s", __FUNCTION__, name);
  return 1;
}

References validator_rule::regex, and validator.

openvas_validator_add()

void openvas_validator_add	(	validator_t	validator,
		const char *	name,
		const char *	regex
	)

Add or overwrite a validation rule.

Parameters

validator	Validator to add rule to.
name	Name of the rule.
regex	Validation rule as a regular expression.

Definition at line 106 of file validator.c.

{
  g_hash_table_insert (validator,
                       (gpointer) g_strdup (name),
                       (gpointer) openvas_validator_rule_new (regex));
}

References openvas_validator_rule_new(), and validator.

Referenced by init_validator().

Here is the call graph for this function:

Here is the caller graph for this function:

openvas_validator_alias()

int openvas_validator_alias	(	validator_t	validator,
		const char *	alias,
		const char *	name
	)

Make an alias for a rule name.

Parameters

validator	Validator to add alias to.
alias	Name of alias for rule.
name	Name of the rule.

Returns

0 success, -1 error.

Definition at line 125 of file validator.c.

{
  gpointer key, value_rule;

  if (g_hash_table_lookup_extended (validator, name, &key, &value_rule))
    {
      validator_rule_t *alias_rule, *rule;
      rule = (validator_rule_t*) value_rule;
      alias_rule = openvas_validator_rule_new (rule->regex
                                                ? rule->regex
                                                : NULL);
      alias_rule->alias_for = g_strdup (name);
      g_hash_table_insert (validator,
                           (gpointer) g_strdup (alias),
                           (gpointer) alias_rule);
      return 0;
    }
  return -1;
}

References validator_rule::alias_for, openvas_validator_rule_new(), validator_rule::regex, and validator.

Referenced by init_validator().

Here is the call graph for this function:

Here is the caller graph for this function:

openvas_validator_alias_for()

gchar* openvas_validator_alias_for	(	validator_t	validator,
		const char *	alias
	)

Get the name of the rule for which a rule is an alias.

Parameters

validator	Validator.
alias	Name of alias.

Returns

Rule name if alias is an alias, else NULL. Freed by openvas_validator_free.

Definition at line 157 of file validator.c.

{
  gpointer key, value_rule;

  if (g_hash_table_lookup_extended (validator, alias, &key, &value_rule))
    {
      validator_rule_t *rule;
      assert (value_rule);
      rule = (validator_rule_t*) value_rule;
      return rule->alias_for;
    }
  return NULL;
}

References validator_rule::alias_for, and validator.

openvas_validator_free()

void openvas_validator_free

(

validator_t

validator

)

Free a validator.

Parameters

validator

Validator.

Definition at line 247 of file validator.c.

{
  if (validator) g_hash_table_destroy (validator);
}

References validator.

openvas_validator_new()

validator_t openvas_validator_new

(

)

Create a new validator.

The validator must be freed with openvas_validator_free.

Returns

A newly allocated validator.

Definition at line 90 of file validator.c.

{
  return g_hash_table_new_full (g_str_hash,
                                g_str_equal,
                                g_free,
                                (void (*) (gpointer)) openvas_validator_rule_free);
}

References openvas_validator_rule_free().

Referenced by init_validator().

Here is the call graph for this function:

Here is the caller graph for this function: