acl.h File Reference

Access Control of various sorts. More...

#include "asterisk/network.h"
#include "asterisk/linkedlists.h"
#include "asterisk/netsock2.h"
#include "asterisk/io.h"

Include dependency graph for acl.h:

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

Go to the source code of this file.

Data Structures
struct	ast_acl
	an ast_acl is a linked list node of ast_ha structs which may have names. More...
struct	ast_acl_list
	Wrapper for an ast_acl linked list. More...
struct	ast_ha
	internal representation of ACL entries In principle user applications would have no need for this, but there is sometimes a need to extract individual items, e.g. to print them, and rather than defining iterators to navigate the list, and an externally visible 'struct ast_ha_entry', at least in the short term it is more convenient to make the whole thing public and let users play with them. More...

Macros
#define	ACL_NAME_LENGTH   80

Enumerations
enum	ast_acl_sense { AST_SENSE_DENY , AST_SENSE_ALLOW }

Functions
int	ast_acl_list_is_empty (struct ast_acl_list *acl_list)
	Determines if an ACL is empty or if it contains entries. More...
void	ast_acl_output (int fd, struct ast_acl_list *acl, const char *prefix)
	output an ACL to the provided fd More...
void	ast_append_acl (const char *sense, const char *stuff, struct ast_acl_list **path, int *error, int *named_acl_flag)
	Add a rule to an ACL struct. More...
struct ast_ha *	ast_append_ha (const char *sense, const char *stuff, struct ast_ha *path, int *error)
	Add a new rule to a list of HAs. More...
struct ast_ha *	ast_append_ha_with_port (const char *sense, const char *stuff, struct ast_ha *path, int *error)
	Add a new rule with optional port to a list of HAs. More...
enum ast_acl_sense	ast_apply_acl (struct ast_acl_list *acl_list, const struct ast_sockaddr *addr, const char *purpose)
	Apply a set of rules to a given IP address. More...
enum ast_acl_sense	ast_apply_acl_nolog (struct ast_acl_list *acl_list, const struct ast_sockaddr *addr)
	Apply a set of rules to a given IP address, don't log failure. More...
enum ast_acl_sense	ast_apply_ha (const struct ast_ha *ha, const struct ast_sockaddr *addr)
	Apply a set of rules to a given IP address. More...
void	ast_copy_ha (const struct ast_ha *from, struct ast_ha *to)
	Copy the contents of one HA to another. More...
struct ast_acl_list *	ast_duplicate_acl_list (struct ast_acl_list *original)
	Duplicates the contests of a list of lists of host access rules. More...
struct ast_ha *	ast_duplicate_ha_list (struct ast_ha *original)
	Duplicate the contents of a list of host access rules. More...
int	ast_find_ourip (struct ast_sockaddr *ourip, const struct ast_sockaddr *bindaddr, int family)
	Find our IP address. More...
struct ast_acl_list *	ast_free_acl_list (struct ast_acl_list *acl)
	Free a list of ACLs. More...
void	ast_free_ha (struct ast_ha *ha)
	Free a list of HAs. More...
int	ast_get_ip (struct ast_sockaddr *addr, const char *hostname)
	Get the IP address given a hostname. More...
int	ast_get_ip_or_srv (struct ast_sockaddr *addr, const char *hostname, const char *service)
	Get the IP address given a hostname and optional service. More...
int	ast_get_ip_or_srv_with_preference (struct ast_sockaddr *addr, const char *hostname, const char *service, struct ast_sockaddr *preference)
	Get the IP address given a hostname and optional service with a preferred result. More...
void	ast_ha_join (const struct ast_ha *ha, struct ast_str **buf)
	Convert HAs to a comma separated string value. More...
void	ast_ha_join_cidr (const struct ast_ha *ha, struct ast_str **buf)
	Convert HAs to a comma separated string value using CIDR notation. More...
void	ast_ha_output (int fd, const struct ast_ha *ha, const char *prefix)
	output an HA to the provided fd More...
int	ast_lookup_iface (char *iface, struct ast_sockaddr *address)
	Find an IP address associated with a specific interface. More...
struct stasis_message_type *	ast_named_acl_change_type (void)
	a stasis_message_type for changes against a named ACL or the set of all named ACLs More...
struct ast_ha *	ast_named_acl_find (const char *name, int *is_realtime, int *is_undefined)
	Retrieve a named ACL. More...
int	ast_ouraddrfor (const struct ast_sockaddr *them, struct ast_sockaddr *us)
	Get our local IP address when contacting a remote host. More...
int	ast_str2cos (const char *value, unsigned int *cos)
	Convert a string to the appropriate COS value. More...
int	ast_str2tos (const char *value, unsigned int *tos)
	Convert a string to the appropriate TOS value. More...
const char *	ast_tos2str (unsigned int tos)
	Convert a TOS value into its string representation. More...

Detailed Description

Access Control of various sorts.

Definition in file acl.h.

Macro Definition Documentation

ACL_NAME_LENGTH

#define ACL_NAME_LENGTH   80

Definition at line 59 of file acl.h.

Enumeration Type Documentation

ast_acl_sense

enum ast_acl_sense

Enumerator
AST_SENSE_DENY
AST_SENSE_ALLOW

Definition at line 36 of file acl.h.

                   {
    AST_SENSE_DENY,
    AST_SENSE_ALLOW
};

Function Documentation

ast_acl_list_is_empty()

int ast_acl_list_is_empty

(

struct ast_acl_list *

acl_list

)

Determines if an ACL is empty or if it contains entries.

Parameters

acl_list

The ACL list being checked

Return values

0	the list is not empty
1	the list is empty

Definition at line 540 of file acl.c.

{
    struct ast_acl *head;
 
    if (!acl_list) {
        return 1;
    }
 
    AST_LIST_LOCK(acl_list);
    head = AST_LIST_FIRST(acl_list);
    AST_LIST_UNLOCK(acl_list);
 
    if (head) {
        return 0;
    }
 
    return 1;
}

References AST_LIST_FIRST, AST_LIST_LOCK, and AST_LIST_UNLOCK.

Referenced by acl_to_str(), apply_acl(), apply_contact_acl(), apply_endpoint_acl(), apply_endpoint_contact_acl(), contact_acl_to_str(), curl_open_socket_cb(), handle_cli_iax2_show_peer(), handle_cli_iax2_show_users(), and handle_showmanager().

ast_acl_output()

void ast_acl_output	(	int	fd,
		struct ast_acl_list *	acl,
		const char *	prefix
	)

output an ACL to the provided fd

This function can be used centrally to output HAs as used in ACLs from other modules. It follows the format as originally used for named ACLs in named_acl.c.

Parameters

fd	The file-descriptor to which to output the ACL.
acl	The ACL to output.
prefix	If you need a specific prefix output on each line, give it here, may be NULL.

Since

13.33.0, 16.10.0, 17.4.0

Definition at line 1115 of file acl.c.

{
    struct ast_acl *acl;
 
    AST_LIST_LOCK(acl_list);
    AST_LIST_TRAVERSE(acl_list, acl, list) {
        ast_cli(fd, "%sACL: %s%s\n---------------------------------------------\n",
                prefix ?: "", ast_strlen_zero(acl->name) ? "(unnamed)" : acl->name,
                acl->is_realtime ? " (realtime)" : "");
 
        ast_ha_output(fd, acl->acl, prefix);
    }
    AST_LIST_UNLOCK(acl_list);
 
}

References ast_acl::acl, ast_cli(), ast_ha_output(), AST_LIST_LOCK, AST_LIST_TRAVERSE, AST_LIST_UNLOCK, ast_strlen_zero(), ast_acl::list, and prefix.

Referenced by handle_showmanager().

ast_append_acl()

void ast_append_acl	(	const char *	sense,
		const char *	stuff,
		struct ast_acl_list **	path,
		int *	error,
		int *	named_acl_flag
	)

Add a rule to an ACL struct.

This adds a named ACL or an ACL rule to an ast_acl container. It works in a similar way to ast_append_ha.

Parameters

	sense	Can be any among "permit", "deny", or "acl" this controls whether the rule being added will simply modify the unnamed ACL at the head of the list or if a new named ACL will be added to that ast_acl.
	stuff	If sense is 'permit'/'deny', this is the ip address and subnet mask separated with a '/' like in ast_append ha. If it sense is 'acl', then this will be the name of the ACL being appended to the container.
	path	Address of the ACL list being appended
[out]	error	The int that error points to will be set to 1 if an error occurs.
[out]	named_acl_flag	This will raise a flag under certain conditions to indicate that a named ACL has been added by this operation. This may be used to indicate that an event subscription should be made against the named ACL subsystem. Note: This flag may be raised by this function, but it will never be lowered by it.

Definition at line 429 of file acl.c.

{
    struct ast_acl *acl = NULL;
    struct ast_acl *current;
    struct ast_acl_list *working_list;
 
    char *tmp, *list;
 
    /* If the ACL list is currently uninitialized, it must be initialized. */
    if (*path == NULL) {
        struct ast_acl_list *list;
        list = ast_calloc(1, sizeof(*list));
        if (!list) {
            /* Allocation Error */
            if (error) {
                *error = 1;
            }
            return;
        }
 
        AST_LIST_HEAD_INIT(list);
        *path = list;
    }
 
    working_list = *path;
 
    AST_LIST_LOCK(working_list);
 
    /* First we need to determine if we will need to add a new ACL node or if we can use an existing one. */
    if (strncasecmp(sense, "a", 1)) {
        /* The first element in the path should be the unnamed, base ACL. If that's the case, we use it. If not,
         * we have to make one and link it up appropriately. */
        current = AST_LIST_FIRST(working_list);
 
        if (!current || !ast_strlen_zero(current->name)) {
            if (acl_new(&acl, "")) {
                if (error) {
                    *error = 1;
                }
                AST_LIST_UNLOCK(working_list);
                return;
            }
            // Need to INSERT the ACL at the head here.
            AST_LIST_INSERT_HEAD(working_list, acl, list);
        } else {
            /* If the first element was already the unnamed base ACL, we just use that one. */
            acl = current;
        }
 
        /* With the proper ACL set for modification, we can just pass this off to the ast_ha append function. */
        acl->acl = ast_append_ha(sense, stuff, acl->acl, error);
 
        AST_LIST_UNLOCK(working_list);
        return;
    }
 
    /* We are in ACL append mode, so we know we'll be adding one or more named ACLs. */
    list = ast_strdupa(stuff);
 
    while ((tmp = strsep(&list, ","))) {
        struct ast_ha *named_ha;
        int already_included = 0;
 
        /* Remove leading whitespace from the string in case the user put spaces between items */
        tmp = ast_skip_blanks(tmp);
 
        /* The first step is to check for a duplicate */
        AST_LIST_TRAVERSE(working_list, current, list) {
            if (!strcasecmp(current->name, tmp)) { /* ACL= */
                /* Inclusion of the same ACL multiple times isn't a catastrophic error, but it will raise the error flag and skip the entry. */
                ast_log(LOG_ERROR, "Named ACL '%s' occurs multiple times in ACL definition. "
                                   "Please update your ACL configuration.\n", tmp);
                if (error) {
                    *error = 1;
                }
                already_included = 1;
                break;
            }
        }
 
        if (already_included) {
            continue;
        }
 
        if (acl_new(&acl, tmp)) {
            /* This is a catastrophic allocation error and we'll return immediately if this happens. */
            if (error) {
                *error = 1;
            }
            AST_LIST_UNLOCK(working_list);
            return;
        }
 
        /* Attempt to grab the Named ACL we are looking for. */
        named_ha = ast_named_acl_find(tmp, &acl->is_realtime, &acl->is_invalid);
 
        /* Set the ACL's ast_ha to the duplicated named ACL retrieved above. */
        acl->acl = named_ha;
 
        /* Raise the named_acl_flag since we are adding a named ACL to the ACL container. */
        if (named_acl_flag) {
            *named_acl_flag = 1;
        }
 
        /* Now insert the new ACL at the end of the list. */
        AST_LIST_INSERT_TAIL(working_list, acl, list);
    }
 
    AST_LIST_UNLOCK(working_list);
}

References acl_new(), ast_append_ha(), ast_calloc, AST_LIST_FIRST, AST_LIST_HEAD_INIT, AST_LIST_INSERT_HEAD, AST_LIST_INSERT_TAIL, AST_LIST_LOCK, AST_LIST_TRAVERSE, AST_LIST_UNLOCK, ast_log, ast_named_acl_find(), ast_skip_blanks(), ast_strdupa, ast_strlen_zero(), current, error(), LOG_ERROR, NULL, strsep(), and tmp().

Referenced by __init_manager(), acl_handler(), build_peer(), build_user(), endpoint_acl_handler(), rtp_reload(), and verification_apply().

ast_append_ha()

struct ast_ha * ast_append_ha	(	const char *	sense,
		const char *	stuff,
		struct ast_ha *	path,
		int *	error
	)

Add a new rule to a list of HAs.

This adds the new host access rule to the end of the list whose head is specified by the path parameter. Rules are evaluated in a way such that if multiple rules apply to a single IP address/subnet mask, then the rule latest in the list will be used.

Parameters

	sense	Either "permit" or "deny" (Actually any 'p' word will result in permission, and any other word will result in denial)
	stuff	The IP address and subnet mask, separated with a '/'. The subnet mask can either be in dotted-decimal format or in CIDR notation (i.e. 0-32).
	path	The head of the HA list to which we wish to append our new rule. If NULL is passed, then the new rule will become the head of the list
[out]	error	The integer error points to will be set non-zero if an error occurs

Returns

The head of the HA list

Definition at line 712 of file acl.c.

{
    return append_ha_core(sense, stuff, path, error, PARSE_PORT_FORBID);
}

References append_ha_core(), error(), PARSE_PORT_FORBID, and ast_ha::sense.

Referenced by acl_handler_fn(), add_calltoken_ignore(), ast_append_acl(), AST_TEST_DEFINE(), build_callno_limits(), build_device(), build_ha(), named_acl_find_realtime(), and transport_localnet_handler().

ast_append_ha_with_port()

struct ast_ha * ast_append_ha_with_port	(	const char *	sense,
		const char *	stuff,
		struct ast_ha *	path,
		int *	error
	)

Add a new rule with optional port to a list of HAs.

Since

13.31.0, 16.8.0, 17.2.0

This adds the new host access rule to the end of the list whose head is specified by the path parameter. Rules are evaluated in a way such that if multiple rules apply to a single IP address/subnet mask, then the rule latest in the list will be used.

Parameters

	sense	Either "permit" or "deny" (Actually any 'p' word will result in permission, and any other word will result in denial)
	stuff	The IP address and subnet mask, separated with a '/'. The subnet mask can either be in dotted-decimal format or in CIDR notation (i.e. 0-32). A port can be provided by placing it after the IP address, separated with a ':'.
	path	The head of the HA list to which we wish to append our new rule. If NULL is passed, then the new rule will become the head of the list
[out]	error	The integer error points to will be set non-zero if an error occurs

Returns

The head of the HA list

Definition at line 717 of file acl.c.

{
    return append_ha_core(sense, stuff, path, error, 0);
}

References append_ha_core(), error(), and ast_ha::sense.

Referenced by ip_identify_match_handler(), ip_identify_match_host_lookup(), and pjsip_enable_logger_host().

ast_apply_acl()

enum ast_acl_sense ast_apply_acl	(	struct ast_acl_list *	acl_list,
		const struct ast_sockaddr *	addr,
		const char *	purpose
	)

Apply a set of rules to a given IP address.

Similar to the above, only uses an acl container, which is a whole slew of ast_ha lists. It runs ast_apply_ha on each of the ast_ha structs contained in the acl container. It will deny if any of the ast_ha lists fail, and it will pass only if all of the rules pass.

Parameters

acl_list	The head of the list of ACLs to evaluate
addr	An ast_sockaddr whose address is considered when matching rules
purpose	Context for which the ACL is being applied - Establishes purpose of a notice when rejected

Return values

AST_SENSE_ALLOW	The IP address passes our ACLs
AST_SENSE_DENY	The IP address fails our ACLs

Definition at line 799 of file acl.c.

                                                                                                                      {
    return ast_apply_acl_internal(acl_list, addr, purpose ?: "");
}

References ast_apply_acl_internal().

Referenced by apply_acl(), apply_contact_acl(), apply_endpoint_acl(), apply_endpoint_contact_acl(), auth_http_callback(), authenticate(), check_access(), curl_open_socket_cb(), and register_verify().

ast_apply_acl_nolog()

enum ast_acl_sense ast_apply_acl_nolog	(	struct ast_acl_list *	acl_list,
		const struct ast_sockaddr *	addr
	)

Apply a set of rules to a given IP address, don't log failure.

Exactly like ast_apply_acl, except that it will never log anything.

Parameters

acl_list	The head of the list of ACLs to evaluate
addr	An ast_sockaddr whose address is considered when matching rules

Return values

AST_SENSE_ALLOW	The IP address passes our ACLs
AST_SENSE_DENY	The IP address fails our ACLs

Definition at line 803 of file acl.c.

                                                                                                       {
    return ast_apply_acl_internal(acl_list, addr, NULL);
}

References ast_apply_acl_internal(), and NULL.

ast_apply_ha()

enum ast_acl_sense ast_apply_ha	(	const struct ast_ha *	ha,
		const struct ast_sockaddr *	addr
	)

Apply a set of rules to a given IP address.

The list of host access rules is traversed, beginning with the input rule. If the IP address given matches a rule, the "sense" of that rule is used as the return value. Note that if an IP address matches multiple rules that the last one matched will be the one whose sense will be returned.

Parameters

ha	The head of the list of host access rules to follow
addr	An ast_sockaddr whose address is considered when matching rules

Return values

AST_SENSE_ALLOW	The IP address passes our ACL
AST_SENSE_DENY	The IP address fails our ACL

Definition at line 807 of file acl.c.

{
    /* Start optimistic */
    enum ast_acl_sense res = AST_SENSE_ALLOW;
    const struct ast_ha *current_ha;
 
    for (current_ha = ha; current_ha; current_ha = current_ha->next) {
        struct ast_sockaddr result;
        struct ast_sockaddr mapped_addr;
        const struct ast_sockaddr *addr_to_use;
        uint16_t save_port;
#if 0   /* debugging code */
        char iabuf[INET_ADDRSTRLEN];
        char iabuf2[INET_ADDRSTRLEN];
        /* DEBUG */
        ast_copy_string(iabuf, ast_sockaddr_stringify(addr), sizeof(iabuf));
        ast_copy_string(iabuf2, ast_sockaddr_stringify(&current_ha->addr), sizeof(iabuf2));
        ast_debug(1, "##### Testing %s with %s\n", iabuf, iabuf2);
#endif
        if (ast_sockaddr_is_ipv4(&current_ha->addr)) {
            if (ast_sockaddr_is_ipv6(addr)) {
                if (ast_sockaddr_is_ipv4_mapped(addr)) {
                    /* IPv4 ACLs apply to IPv4-mapped addresses */
                    if (!ast_sockaddr_ipv4_mapped(addr, &mapped_addr)) {
                        ast_log(LOG_ERROR, "%s provided to ast_sockaddr_ipv4_mapped could not be converted. That shouldn't be possible.\n",
                            ast_sockaddr_stringify(addr));
                        continue;
                    }
                    addr_to_use = &mapped_addr;
                } else {
                    /* An IPv4 ACL does not apply to an IPv6 address */
                    continue;
                }
            } else {
                /* Address is IPv4 and ACL is IPv4. No biggie */
                addr_to_use = addr;
            }
        } else {
            if (ast_sockaddr_is_ipv6(addr) && !ast_sockaddr_is_ipv4_mapped(addr)) {
                addr_to_use = addr;
            } else {
                /* Address is IPv4 or IPv4 mapped but ACL is IPv6. Skip */
                continue;
            }
        }
 
        /* ast_sockaddr_apply_netmask() does not preserve the port, so we need to save and
         * restore it */
        save_port = ast_sockaddr_port(addr_to_use);
 
        /* For each rule, if this address and the netmask = the net address
           apply the current rule */
        if (ast_sockaddr_apply_netmask(addr_to_use, &current_ha->netmask, &result)) {
            /* Unlikely to happen since we know the address to be IPv4 or IPv6 */
            continue;
        }
 
        ast_sockaddr_set_port(&result, save_port);
 
        if (!ast_sockaddr_cmp_addr(&result, &current_ha->addr)
           && (!ast_sockaddr_port(&current_ha->addr)
              || ast_sockaddr_port(&current_ha->addr) == ast_sockaddr_port(&result))) {
            res = current_ha->sense;
        }
    }
    return res;
}

References ast_ha::addr, ast_copy_string(), ast_debug, ast_log, AST_SENSE_ALLOW, ast_sockaddr_apply_netmask(), ast_sockaddr_cmp_addr(), ast_sockaddr_ipv4_mapped(), ast_sockaddr_is_ipv4(), ast_sockaddr_is_ipv4_mapped(), ast_sockaddr_is_ipv6(), ast_sockaddr_port, ast_sockaddr_set_port, ast_sockaddr_stringify(), LOG_ERROR, ast_ha::netmask, ast_ha::next, result, and ast_ha::sense.

Referenced by ast_apply_acl_internal(), AST_TEST_DEFINE(), ip_identify_match_check(), ip_identify_match_host_lookup(), and pjsip_log_test_filter().

ast_copy_ha()

void ast_copy_ha	(	const struct ast_ha *	from,
		struct ast_ha *	to
	)

Copy the contents of one HA to another.

This copies the internals of the 'from' HA to the 'to' HA. It is important that the 'to' HA has been allocated prior to calling this function

Parameters

from	Source HA to copy
to	Destination HA to copy to

Definition at line 255 of file acl.c.

{
    ast_sockaddr_copy(&to->addr, &from->addr);
    ast_sockaddr_copy(&to->netmask, &from->netmask);
    to->sense = from->sense;
}

References ast_ha::addr, ast_sockaddr_copy(), ast_ha::netmask, and ast_ha::sense.

Referenced by add_calltoken_ignore(), ast_duplicate_ha(), and build_callno_limits().

ast_duplicate_acl_list()

struct ast_acl_list * ast_duplicate_acl_list

(

struct ast_acl_list *

original

)

Duplicates the contests of a list of lists of host access rules.

A deep copy of an ast_acl list is made (which in turn means a deep copy of each of the ast_ha structs contained within). The returned value is allocated on the heap and must be freed independently of the input paramater when finished.

Parameters

original

The ast_acl_list to copy

Returns

The new duplicated ast_acl_list

Definition at line 315 of file acl.c.

{
    struct ast_acl_list *clone;
    struct ast_acl *current_cursor;
    struct ast_acl *current_clone;
 
    /* Early return if we receive a duplication request for a NULL original. */
    if (!original) {
        return NULL;
    }
 
    if (!(clone = ast_calloc(1, sizeof(*clone)))) {
        ast_log(LOG_ERROR, "Failed to allocate ast_acl_list struct while cloning an ACL\n");
        return NULL;
    }
    AST_LIST_HEAD_INIT(clone);
 
    AST_LIST_LOCK(original);
 
    AST_LIST_TRAVERSE(original, current_cursor, list) {
        if ((acl_new(&current_clone, current_cursor->name))) {
            ast_log(LOG_ERROR, "Failed to allocate ast_acl struct while cloning an ACL.\n");
            ast_free_acl_list(clone);
            clone = NULL;
            break;
        }
 
        /* Copy data from original ACL to clone ACL */
        current_clone->acl = ast_duplicate_ha_list(current_cursor->acl);
 
        current_clone->is_invalid = current_cursor->is_invalid;
        current_clone->is_realtime = current_cursor->is_realtime;
 
        AST_LIST_INSERT_TAIL(clone, current_clone, list);
 
        if (current_cursor->acl && !current_clone->acl) {
            /* Deal with failure after adding to clone so we don't have to free
             * current_clone separately. */
            ast_log(LOG_ERROR, "Failed to duplicate HA list while cloning ACL.\n");
            ast_free_acl_list(clone);
            clone = NULL;
            break;
        }
    }
 
    AST_LIST_UNLOCK(original);
 
    return clone;
}

References ast_acl::acl, acl_new(), ast_calloc, ast_duplicate_ha_list(), ast_free_acl_list(), AST_LIST_HEAD_INIT, AST_LIST_INSERT_TAIL, AST_LIST_LOCK, AST_LIST_TRAVERSE, AST_LIST_UNLOCK, ast_log, ast_acl::is_invalid, ast_acl::is_realtime, ast_acl::list, LOG_ERROR, ast_acl::name, and NULL.

Referenced by vs_copy_cfg_common().

ast_duplicate_ha_list()

struct ast_ha * ast_duplicate_ha_list

(

struct ast_ha *

original

)

Duplicate the contents of a list of host access rules.

A deep copy of all ast_has in the list is made. The returned value is allocated on the heap and must be freed independently of the input parameter when finished.

Parameters

original

The ast_ha to copy

Returns

The head of the list of duplicated ast_has

Definition at line 276 of file acl.c.

{
    struct ast_ha *start = original;
    struct ast_ha *ret = NULL;
    struct ast_ha *current, *prev = NULL;
 
    while (start) {
        current = ast_duplicate_ha(start);  /* Create copy of this object */
        if (!current) {
            ast_free_ha(ret);
 
            return NULL;
        }
 
        if (prev) {
            prev->next = current;           /* Link previous to this object */
        }
 
        if (!ret) {
            ret = current;                  /* Save starting point */
        }
 
        start = start->next;                /* Go to next object */
        prev = current;                     /* Save pointer to this object */
    }
    return ret;                             /* Return start of list */
}

References ast_duplicate_ha(), ast_free_ha(), current, ast_ha::next, and NULL.

Referenced by ast_duplicate_acl_list(), and ast_named_acl_find().

ast_find_ourip()

int ast_find_ourip	(	struct ast_sockaddr *	ourip,
		const struct ast_sockaddr *	bindaddr,
		int	family
	)

Find our IP address.

This function goes through many iterations in an attempt to find our IP address. If any step along the way should fail, we move to the next item in the list. Here are the steps taken:

• If bindaddr has a non-zero IP address, that is copied into ourip
• We use a combination of gethostname and ast_gethostbyname to find our IP address.
• We use ast_ouraddrfor with 198.41.0.4 as the destination IP address
• We try some platform-specific socket operations to find the IP address

Parameters

[out]	ourip	Our IP address is written here when it is found
	bindaddr	A hint used for finding our IP. See the steps above for more details
	family	Only addresses of the given family will be returned. Use 0 or AST_SOCKADDR_UNSPEC to get addresses of all families.

Return values

0	Success
-1	Failure

Definition at line 1068 of file acl.c.

{
    char ourhost[MAXHOSTNAMELEN] = "";
    struct ast_sockaddr root;
    int res, port = ast_sockaddr_port(ourip);
 
    /* just use the bind address if it is nonzero */
    if (!ast_sockaddr_is_any(bindaddr)) {
        ast_sockaddr_copy(ourip, bindaddr);
        ast_debug(3, "Attached to given IP address\n");
        return 0;
    }
    /* try to use our hostname */
    if (gethostname(ourhost, sizeof(ourhost) - 1)) {
        ast_log(LOG_WARNING, "Unable to get hostname\n");
    } else {
        if (resolve_match_or_first(ourip, ourhost, PARSE_PORT_FORBID, family, NULL) == 0) {
            /* reset port since resolve_match_or_first wipes this out */
            ast_sockaddr_set_port(ourip, port);
            return 0;
        }
    }
    ast_debug(3, "Trying to check A.ROOT-SERVERS.NET and get our IP address for that connection\n");
    /* A.ROOT-SERVERS.NET. */
    if (!resolve_match_or_first(&root, "A.ROOT-SERVERS.NET", PARSE_PORT_FORBID, 0, NULL) &&
        !ast_ouraddrfor(&root, ourip)) {
        /* reset port since resolve_match_or_first wipes this out */
        ast_sockaddr_set_port(ourip, port);
        return 0;
    }
    res = get_local_address(ourip);
    ast_sockaddr_set_port(ourip, port);
    return res;
}

References ast_debug, ast_log, ast_ouraddrfor(), ast_sockaddr_copy(), ast_sockaddr_is_any(), ast_sockaddr_port, ast_sockaddr_set_port, bindaddr, get_local_address(), LOG_WARNING, MAXHOSTNAMELEN, NULL, PARSE_PORT_FORBID, and resolve_match_or_first().

Referenced by ast_rtp_prop_set().

ast_free_acl_list()

struct ast_acl_list * ast_free_acl_list

(

struct ast_acl_list *

acl

)

Free a list of ACLs.

Given the head of a list of ast_acl structs, it and all appended acl structs will be freed. This includes the ast_ha structs within the individual nodes.

Parameters

acl	The list of ACLs to free

Return values

NULL

Definition at line 233 of file acl.c.

{
    struct ast_acl *current;
 
    if (!acl_list) {
        return NULL;
    }
 
    AST_LIST_LOCK(acl_list);
    while ((current = AST_LIST_REMOVE_HEAD(acl_list, list))) {
        ast_free_ha(current->acl);
        ast_free(current);
    }
    AST_LIST_UNLOCK(acl_list);
 
    AST_LIST_HEAD_DESTROY(acl_list);
    ast_free(acl_list);
 
    return NULL;
}

References ast_free, ast_free_ha(), AST_LIST_HEAD_DESTROY, AST_LIST_LOCK, AST_LIST_REMOVE_HEAD, AST_LIST_UNLOCK, current, ast_acl::list, and NULL.

Referenced by __init_manager(), acl_destroy(), ast_duplicate_acl_list(), build_peer(), build_user(), endpoint_destructor(), manager_free_user(), peer_destructor(), rtp_reload(), user_destructor(), vcfg_cleanup(), verification_apply(), and vs_copy_cfg_common().

ast_free_ha()

void ast_free_ha

(

struct ast_ha *

ha

)

Free a list of HAs.

Given the head of a list of HAs, it and all appended HAs are freed

Parameters

ha	The head of the list of HAs to free

Definition at line 222 of file acl.c.

{
    struct ast_ha *hal;
    while (ha) {
        hal = ha;
        ha = ha->next;
        ast_free(hal);
    }
}

References ast_free, and ast_ha::next.

Referenced by add_calltoken_ignore(), append_ha_core(), ast_duplicate_ha_list(), ast_free_acl_list(), AST_TEST_DEFINE(), build_callno_limits(), destroy_named_acl(), destroy_sip_transport_state(), ip_identify_destroy(), named_acl_find_realtime(), pjsip_disable_logger(), pjsip_enable_logger_host(), pjsip_logger_session_destroy(), test_item_destructor(), and transport_localnet_handler().

ast_get_ip()

int ast_get_ip	(	struct ast_sockaddr *	addr,
		const char *	hostname
	)

Get the IP address given a hostname.

Similar in nature to ast_gethostbyname, except that instead of getting an entire hostent structure, you instead are given only the IP address inserted into a ast_sockaddr structure.

Parameters

addr	The IP address found. The address family is used as an input parameter to filter the returned addresses. If it is AST_AF_UNSPEC, both IPv4 and IPv6 addresses can be returned.
hostname	The hostname to look up

Return values

0	Success
-1	Failure

Definition at line 1016 of file acl.c.

{
    return ast_get_ip_or_srv(addr, hostname, NULL);
}

References ast_get_ip_or_srv(), hostname, and NULL.

Referenced by build_peer(), peer_set_srcaddr(), setup_stunaddr(), and stun_monitor_request().

ast_get_ip_or_srv()

int ast_get_ip_or_srv	(	struct ast_sockaddr *	addr,
		const char *	hostname,
		const char *	service
	)

Get the IP address given a hostname and optional service.

If the service parameter is non-NULL, then an SRV lookup will be made by prepending the service to the hostname parameter, separated by a '.' For example, if hostname is "example.com" and service is "_sip._udp" then an SRV lookup will be done for "_sip._udp.example.com". If service is NULL, then this function acts exactly like a call to ast_get_ip.

Parameters

addr	The IP address found. The address family is used as an input parameter to filter the returned addresses. If it is 0, both IPv4 and IPv6 addresses can be returned.
hostname	The hostname to look up
service	A specific service provided by the host. A NULL service results in an A-record lookup instead of an SRV lookup

Return values

0	Success
-1	Failure

Definition at line 933 of file acl.c.

{
    return ast_get_ip_or_srv_with_preference(addr, hostname, service, NULL);
}

References ast_get_ip_or_srv_with_preference(), hostname, NULL, and service.

Referenced by ast_get_ip(), create_addr(), and internal_dnsmgr_lookup().

ast_get_ip_or_srv_with_preference()

int ast_get_ip_or_srv_with_preference	(	struct ast_sockaddr *	addr,
		const char *	hostname,
		const char *	service,
		struct ast_sockaddr *	preference
	)

Get the IP address given a hostname and optional service with a preferred result.

If the service parameter is non-NULL, then an SRV lookup will be made by prepending the service to the hostname parameter, separated by a '.' For example, if hostname is "example.com" and service is "_sip._udp" then an SRV lookup will be done for "_sip._udp.example.com". If service is NULL, then this function acts exactly like a call to ast_get_ip.

Parameters

addr	The IP address found. The address family is used as an input parameter to filter the returned addresses. If it is 0, both IPv4 and IPv6 addresses can be returned.
hostname	The hostname to look up
service	A specific service provided by the host. A NULL service results in an A-record lookup instead of an SRV lookup
preference	The preferred IP address to return. If multiple results are available and this IP address is in the list then it will be returned. If NULL, or if the none of the returned IP addresses match, then the first IP address will be returned.

Return values

0	Success
-1	Failure

Definition at line 907 of file acl.c.

{
    char srv[256];
    char host[256];
    int srv_ret = 0;
    int tportno;
 
    if (service) {
        snprintf(srv, sizeof(srv), "%s.%s", service, hostname);
        if ((srv_ret = ast_get_srv(NULL, host, sizeof(host), &tportno, srv)) > 0) {
            hostname = host;
        }
    }
 
    if (resolve_match_or_first(addr, hostname, PARSE_PORT_FORBID, addr->ss.ss_family, preference) != 0) {
        return -1;
    }
 
    if (srv_ret > 0) {
        ast_sockaddr_set_port(addr, tportno);
    }
 
    return 0;
}

References ast_get_srv(), ast_sockaddr_set_port, hostname, NULL, PARSE_PORT_FORBID, resolve_match_or_first(), service, and ast_sockaddr::ss.

Referenced by ast_get_ip_or_srv(), and dnsmgr_refresh().

ast_ha_join()

void ast_ha_join	(	const struct ast_ha *	ha,
		struct ast_str **	buf
	)

Convert HAs to a comma separated string value.

Parameters

ha	the starting ha head
buf	string buffer to convert data to

Definition at line 722 of file acl.c.

{
    for (; ha; ha = ha->next) {
        const char *addr;
 
        if (ast_sockaddr_port(&ha->addr)) {
            addr = ast_sockaddr_stringify(&ha->addr);
        } else {
            addr = ast_sockaddr_stringify_addr(&ha->addr);
        }
 
        ast_str_append(buf, 0, "%s%s/",
            ha->sense == AST_SENSE_ALLOW ? "!" : "",
            addr);
        /* Separated to avoid duplicating stringified addresses. */
        ast_str_append(buf, 0, "%s", ast_sockaddr_stringify_addr(&ha->netmask));
        if (ha->next) {
            ast_str_append(buf, 0, ",");
        }
    }
}

References ast_ha::addr, AST_SENSE_ALLOW, ast_sockaddr_port, ast_sockaddr_stringify(), ast_sockaddr_stringify_addr(), ast_str_append(), buf, ast_ha::netmask, ast_ha::next, and ast_ha::sense.

Referenced by localnet_to_str(), and match_to_str().

ast_ha_join_cidr()

void ast_ha_join_cidr	(	const struct ast_ha *	ha,
		struct ast_str **	buf
	)

Convert HAs to a comma separated string value using CIDR notation.

Parameters

ha	the starting ha head
buf	string buffer to convert data to

Definition at line 744 of file acl.c.

{
    for (; ha; ha = ha->next) {
        const char *addr = ast_sockaddr_stringify_addr(&ha->addr);
        ast_str_append(buf, 0, "%s%s/%d",
                   ha->sense == AST_SENSE_ALLOW ? "!" : "",
                   addr, ast_sockaddr_cidr_bits(&ha->netmask));
        if (ha->next) {
            ast_str_append(buf, 0, ",");
        }
    }
}

References ast_ha::addr, AST_SENSE_ALLOW, ast_sockaddr_cidr_bits(), ast_sockaddr_stringify_addr(), ast_str_append(), buf, ast_ha::netmask, ast_ha::next, and ast_ha::sense.

ast_ha_output()

void ast_ha_output	(	int	fd,
		const struct ast_ha *	ha,
		const char *	prefix
	)

output an HA to the provided fd

This function can be used centrally to output HAs as used in ACLs from other modules. It follows the format as originally used for named ACLs in named_acl.c.

Parameters

fd	The file-descriptor to which to output the HA.
ha	The HA to output.
prefix	If you need a specific prefix output on each line, give it here, may be NULL.

Since

13.33.0, 16.10.0, 17.4.0

Definition at line 1103 of file acl.c.

{
    char addr[AST_SOCKADDR_BUFLEN];
    char *mask;
    int index = 0;
    for (; ha; ha = ha->next, ++index) {
        strcpy(addr, ast_sockaddr_stringify_addr(&ha->addr));
        mask = ast_sockaddr_stringify_addr(&ha->netmask);
        ast_cli(fd, "%s%3d: %s - %s/%s\n", prefix ?: "", index, ha->sense == AST_SENSE_ALLOW ? "allow" : " deny", addr, mask);
    }
}

References ast_ha::addr, ast_cli(), AST_SENSE_ALLOW, AST_SOCKADDR_BUFLEN, ast_sockaddr_stringify_addr(), ast_ha::netmask, ast_ha::next, prefix, and ast_ha::sense.

Referenced by ast_acl_output(), cli_display_named_acl(), and print_acl().

ast_lookup_iface()

int ast_lookup_iface	(	char *	iface,
		struct ast_sockaddr *	address
	)

Find an IP address associated with a specific interface.

Given an interface such as "eth0" we find the primary IP address associated with it using the SIOCGIFADDR ioctl. If the ioctl call should fail, we populate address with 0s.

Note

This function is not actually used anywhere

Parameters

	iface	The interface name whose IP address we wish to find
[out]	address	The interface's IP address is placed into this param

Return values

-1	Failure, address is filled with 0s
0	Success

ast_named_acl_change_type()

struct stasis_message_type * ast_named_acl_change_type

(

void

)

a stasis_message_type for changes against a named ACL or the set of all named ACLs

Since

12

Return values

NULL

on error

Returns

stasis_message_type for named ACL changes

Note

Messages of this type should always be issued on and expected from the ast_security_topic stasis_topic

Referenced by acl_change_stasis_cb(), acl_change_stasis_subscribe(), ast_res_pjsip_initialize_configuration(), common_config_load(), load_module(), named_acl_changed_cb(), publish_acl_change(), rtp_reload(), and unload_module().

ast_named_acl_find()

struct ast_ha * ast_named_acl_find	(	const char *	name,
		int *	is_realtime,
		int *	is_undefined
	)

Retrieve a named ACL.

This function attempts to find a named ACL. If found, a copy of the requested ACL will be made which must be freed by the caller.

Parameters

	name	Name of the ACL sought
[out]	is_realtime	will be true if the ACL being returned is from realtime
[out]	is_undefined	will be true if no ACL profile can be found for the requested name

Returns

A copy of the named ACL as an ast_ha

Return values

NULL	if no ACL could be found.

Definition at line 293 of file named_acl.c.

{
    struct ast_ha *ha = NULL;
 
    RAII_VAR(struct named_acl_config *, cfg, ao2_global_obj_ref(globals), ao2_cleanup);
    RAII_VAR(struct named_acl *, named_acl, NULL, ao2_cleanup);
 
    if (is_realtime) {
        *is_realtime = 0;
    }
 
    if (is_undefined) {
        *is_undefined = 0;
    }
 
    /* If the config or its named_acl_list hasn't been initialized, abort immediately. */
    if ((!cfg) || (!(cfg->named_acl_list))) {
        ast_log(LOG_ERROR, "Attempted to find named ACL '%s', but the ACL configuration isn't available.\n", name);
        return NULL;
    }
 
    named_acl = named_acl_find(cfg->named_acl_list, name);
 
    /* If a named ACL couldn't be retrieved locally, we need to try realtime storage. */
    if (!named_acl) {
        RAII_VAR(struct named_acl *, realtime_acl, NULL, ao2_cleanup);
 
        /* Attempt to create from realtime */
        if ((realtime_acl = named_acl_find_realtime(name))) {
            if (is_realtime) {
                *is_realtime = 1;
            }
            ha = ast_duplicate_ha_list(realtime_acl->ha);
            return ha;
        }
 
        /* Couldn't create from realtime. Raise relevant flags and print relevant warnings. */
        if (ast_realtime_is_mapping_defined(ACL_FAMILY) && !ast_check_realtime(ACL_FAMILY)) {
            ast_log(LOG_WARNING, "ACL '%s' does not exist. The ACL will be marked as undefined and will automatically fail if applied.\n"
                "This ACL may exist in the configured realtime backend, but that backend hasn't been registered yet. "
                "Fix this establishing preload for the backend in 'modules.conf'.\n", name);
        } else {
            ast_log(LOG_WARNING, "ACL '%s' does not exist. The ACL will be marked as undefined and will automatically fail if applied.\n", name);
        }
 
        if (is_undefined) {
            *is_undefined = 1;
        }
 
        return NULL;
    }
 
    ha = ast_duplicate_ha_list(named_acl->ha);
 
    if (!ha) {
        ast_log(LOG_NOTICE, "ACL '%s' contains no rules. It is valid, but it will accept addresses unconditionally.\n", name);
    }
 
    return ha;
}

References ACL_FAMILY, ao2_cleanup, ao2_global_obj_ref, ast_check_realtime(), ast_duplicate_ha_list(), ast_log, ast_realtime_is_mapping_defined(), globals, named_acl::ha, LOG_ERROR, LOG_NOTICE, LOG_WARNING, name, named_acl_find(), named_acl_find_realtime(), NULL, and RAII_VAR.

Referenced by ast_append_acl().

ast_ouraddrfor()

int ast_ouraddrfor	(	const struct ast_sockaddr *	them,
		struct ast_sockaddr *	us
	)

Get our local IP address when contacting a remote host.

This function will attempt to connect(2) to them over UDP using a source port of 5060. If the connect(2) call is successful, then we inspect the sockaddr_in output parameter of connect(2) to determine the IP address used to connect to them. This IP address is then copied into us.

Parameters

	them	The IP address to which we wish to attempt to connect
[out]	us	The source IP address used to connect to them

Return values

-1	Failure
0	Success

Definition at line 1021 of file acl.c.

{
    /*
     * We must create the errno string before creating the address
     * string because it could wipe out errno on the error return
     * paths.
     */
    const char *sock_err;
    int port;
    int s;
 
    /* Preserve our original address port */
    port = ast_sockaddr_port(us);
 
    s = socket(ast_sockaddr_is_ipv6(them) ? AF_INET6 : AF_INET, SOCK_DGRAM, 0);
    if (s < 0) {
        sock_err = ast_strdupa(strerror(errno));
        ast_log(LOG_ERROR, "Cannot create socket to %s: %s\n",
            ast_sockaddr_stringify_addr(them), sock_err);
        return -1;
    }
 
    if (ast_connect(s, them)) {
        sock_err = ast_strdupa(strerror(errno));
        ast_log(LOG_WARNING, "Cannot connect to %s: %s\n",
            ast_sockaddr_stringify_addr(them), sock_err);
        close(s);
        return -1;
    }
    if (ast_getsockname(s, us)) {
        sock_err = ast_strdupa(strerror(errno));
        ast_log(LOG_WARNING, "Cannot get socket name for connection to %s: %s\n",
            ast_sockaddr_stringify_addr(them), sock_err);
        close(s);
        return -1;
    }
    close(s);
 
    ast_sockaddr_set_port(us, port);
 
    ast_debug(3, "For destination '%s', our source address is '%s'.\n",
        ast_strdupa(ast_sockaddr_stringify_addr(them)),
        ast_strdupa(ast_sockaddr_stringify_addr(us)));
 
    return 0;
}

References ast_connect(), ast_debug, ast_getsockname(), ast_log, ast_sockaddr_is_ipv6(), ast_sockaddr_port, ast_sockaddr_set_port, ast_sockaddr_stringify_addr(), ast_strdupa, errno, LOG_ERROR, and LOG_WARNING.

Referenced by ast_find_ourip(), ast_rtp_remote_address_set(), and unicast_rtp_request().

ast_str2cos()

int ast_str2cos	(	const char *	value,
		unsigned int *	cos
	)

Convert a string to the appropriate COS value.

Parameters

	value	The COS string to convert
[out]	cos	The integer representation of that COS value

Return values

-1	Failure
0	Success

Definition at line 969 of file acl.c.

{
    int fval;
 
    if (sscanf(value, "%30d", &fval) == 1) {
        if (fval < 8) {
            *cos = fval;
            return 0;
        }
    }
 
    return -1;
}

References cos, and value.

Referenced by reload_config(), and set_config().

ast_str2tos()

int ast_str2tos	(	const char *	value,
		unsigned int *	tos
	)

Convert a string to the appropriate TOS value.

Parameters

	value	The TOS string to convert
[out]	tos	The integer representation of that TOS value

Return values

-1	Failure
0	Success

Definition at line 983 of file acl.c.

{
    int fval;
    unsigned int x;
 
    if (sscanf(value, "%30i", &fval) == 1) {
        *tos = fval & 0xFF;
        return 0;
    }
 
    for (x = 0; x < ARRAY_LEN(dscp_pool1); x++) {
        if (!strcasecmp(value, dscp_pool1[x].name)) {
            *tos = dscp_pool1[x].space << 2;
            return 0;
        }
    }
 
    return -1;
}

References ARRAY_LEN, dscp_pool1, name, dscp_codepoint::space, tos, and value.

Referenced by iax_template_parse(), reload_config(), set_config(), tos_handler(), and transport_tos_handler().

ast_tos2str()

const char * ast_tos2str

(

unsigned int

tos

)

Convert a TOS value into its string representation.

Parameters

tos	The TOS value to look up

Returns

The string equivalent of the TOS value

Definition at line 1003 of file acl.c.

{
    unsigned int x;
 
    for (x = 0; x < ARRAY_LEN(dscp_pool1); x++) {
        if (dscp_pool1[x].space == (tos >> 2)) {
            return dscp_pool1[x].name;
        }
    }
 
    return "unknown";
}

References ARRAY_LEN, dscp_pool1, dscp_codepoint::name, dscp_codepoint::space, and tos.