acl.h File Reference

Low-level API for XML Access Control Lists (ACLs) More...

#include <libxml/tree.h>
#include <stdbool.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.

Functions
bool	xml_acl_enabled (const xmlNode *xml)
	Check whether or not an XML node is ACL-enabled. More...
void	xml_acl_disable (xmlNode *xml)
bool	xml_acl_denied (const xmlNode *xml)
	Check whether or not an XML node is ACL-denied. More...
bool	xml_acl_filtered_copy (const char *user, xmlNode *acl_source, xmlNode *xml, xmlNode **result)
	Copy ACL-allowed portions of specified XML. More...
bool	pcmk_acl_required (const char *user)
	Check whether ACLs are required for a given user. More...

Detailed Description

Low-level API for XML Access Control Lists (ACLs)

Definition in file acl.h.

Function Documentation

pcmk_acl_required()

bool pcmk_acl_required

(

const char *

user

)

Check whether ACLs are required for a given user.

Parameters

[in]

User

name to check

Returns

true if the user requires ACLs, false otherwise

Definition at line 743 of file acl.c.

xml_acl_denied()

bool xml_acl_denied

(

const xmlNode *

xml

)

Check whether or not an XML node is ACL-denied.

Parameters

[in]

xml

node to check

Returns

true if XML node exists and is ACL-denied, false otherwise

Definition at line 605 of file acl.c.

xml_acl_disable()

void xml_acl_disable

(

xmlNode *

xml

)

Definition at line 616 of file acl.c.

xml_acl_enabled()

bool xml_acl_enabled

(

const xmlNode *

xml

)

Check whether or not an XML node is ACL-enabled.

Parameters

[in]

xml

node to check

Returns

true if XML node exists and is ACL-enabled, false otherwise

Definition at line 636 of file acl.c.

xml_acl_filtered_copy()

bool xml_acl_filtered_copy	(	const char *	user,
		xmlNode *	acl_source,
		xmlNode *	xml,
		xmlNode **	result
	)

Copy ACL-allowed portions of specified XML.

Parameters

[in]	user	Username whose ACLs should be used
[in]	acl_source	XML containing ACLs
[in]	xml	XML to be copied
[out]	result	Copy of XML portions readable via ACLs

Returns

true if xml exists and ACLs are required for user, false otherwise

Note

If this returns true, caller should use result rather than xml

Definition at line 435 of file acl.c.