crmcommon_private.h File Reference

#include <stdint.h>
#include <stdbool.h>
#include <sys/types.h>
#include <glib.h>
#include <libxml/tree.h>
#include <qb/qbipcc.h>

Include dependency graph for crmcommon_private.h:

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

Go to the source code of this file.

Data Structures
struct	pcmk__deleted_xml_s
struct	xml_private_s
struct	pcmk__ipc_methods_s
struct	pcmk_ipc_api_s
struct	pcmk__ipc_header_s

Macros
#define	PCMK__BUFFER_SIZE   4096
#define	pcmk__set_xml_flags(xml_priv, flags_to_set)
#define	pcmk__clear_xml_flags(xml_priv, flags_to_clear)
#define	PCMK__IPC_VERSION   1
#define	PCMK__CONTROLD_API_MAJOR   "1"
#define	PCMK__CONTROLD_API_MINOR   "0"

Typedefs
typedef struct pcmk__deleted_xml_s	pcmk__deleted_xml_t
typedef struct xml_private_s	xml_private_t
typedef struct pcmk__ipc_methods_s	pcmk__ipc_methods_t
typedef struct pcmk__ipc_header_s	pcmk__ipc_header_t

Enumerations
enum	xml_private_flags {   xpf_none = 0x0000, xpf_dirty = 0x0001, xpf_deleted = 0x0002, xpf_created = 0x0004,   xpf_modified = 0x0008, xpf_tracking = 0x0010, xpf_processed = 0x0020, xpf_skip = 0x0040,   xpf_moved = 0x0080, xpf_acl_enabled = 0x0100, xpf_acl_read = 0x0200, xpf_acl_write = 0x0400,   xpf_acl_deny = 0x0800, xpf_acl_create = 0x1000, xpf_acl_denied = 0x2000, xpf_lazy = 0x4000 }

Functions
G_GNUC_INTERNAL void	pcmk__xml2text (xmlNode *data, int options, char **buffer, int *offset, int *max, int depth)
G_GNUC_INTERNAL void	pcmk__buffer_add_char (char **buffer, int *offset, int *max, char c)
G_GNUC_INTERNAL void	pcmk__set_xml_doc_flag (xmlNode *xml, enum xml_private_flags flag)
G_GNUC_INTERNAL bool	pcmk__tracking_xml_changes (xmlNode *xml, bool lazy)
G_GNUC_INTERNAL int	pcmk__element_xpath (const char *prefix, xmlNode *xml, char *buffer, int offset, size_t buffer_size)
G_GNUC_INTERNAL void	pcmk__mark_xml_created (xmlNode *xml)
G_GNUC_INTERNAL int	pcmk__xml_position (xmlNode *xml, enum xml_private_flags ignore_if_set)
G_GNUC_INTERNAL xmlNode *	pcmk__xml_match (xmlNode *haystack, xmlNode *needle, bool exact)
G_GNUC_INTERNAL void	pcmk__xe_log (int log_level, const char *file, const char *function, int line, const char *prefix, xmlNode *data, int depth, int options)
G_GNUC_INTERNAL void	pcmk__xml_update (xmlNode *parent, xmlNode *target, xmlNode *update, bool as_diff)
G_GNUC_INTERNAL xmlNode *	pcmk__xc_match (xmlNode *root, xmlNode *search_comment, bool exact)
G_GNUC_INTERNAL void	pcmk__xc_update (xmlNode *parent, xmlNode *target, xmlNode *update)
G_GNUC_INTERNAL void	pcmk__free_acls (GList *acls)
G_GNUC_INTERNAL void	pcmk__unpack_acl (xmlNode *source, xmlNode *target, const char *user)
G_GNUC_INTERNAL bool	pcmk__check_acl (xmlNode *xml, const char *name, enum xml_private_flags mode)
G_GNUC_INTERNAL void	pcmk__apply_acl (xmlNode *xml)
G_GNUC_INTERNAL void	pcmk__apply_creation_acl (xmlNode *xml, bool check_top)
G_GNUC_INTERNAL void	pcmk__mark_xml_attr_dirty (xmlAttr *a)
G_GNUC_INTERNAL bool	pcmk__xa_filterable (const char *name)
G_GNUC_INTERNAL int	pcmk__send_ipc_request (pcmk_ipc_api_t *api, xmlNode *request)
G_GNUC_INTERNAL void	pcmk__call_ipc_callback (pcmk_ipc_api_t *api, enum pcmk_ipc_event event_type, crm_exit_t status, void *event_data)
G_GNUC_INTERNAL unsigned int	pcmk__ipc_buffer_size (unsigned int max)
G_GNUC_INTERNAL bool	pcmk__valid_ipc_header (const pcmk__ipc_header_t *header)
G_GNUC_INTERNAL pcmk__ipc_methods_t *	pcmk__controld_api_methods (void)
G_GNUC_INTERNAL pcmk__ipc_methods_t *	pcmk__pacemakerd_api_methods (void)
int	pcmk__crm_ipc_is_authentic_process (qb_ipcc_connection_t *qb_ipc, int sock, uid_t refuid, gid_t refgid, pid_t *gotpid, uid_t *gotuid, gid_t *gotgid)
	Check the authenticity of the IPC socket peer process. More...

Macro Definition Documentation

#define PCMK__BUFFER_SIZE   4096

Definition at line 25 of file crmcommon_private.h.

#define pcmk__clear_xml_flags	(		xml_priv,
			flags_to_clear
	)

Value:

do {                \
        (xml_priv)->flags = pcmk__clear_flags_as(__func__, __LINE__,        \
            LOG_NEVER, "XML", "XML node", (xml_priv)->flags,                \
            (flags_to_clear), #flags_to_clear);                             \
    } while (0)

Definition at line 75 of file crmcommon_private.h.

#define PCMK__CONTROLD_API_MAJOR   "1"

Definition at line 157 of file crmcommon_private.h.

#define PCMK__CONTROLD_API_MINOR   "0"

Definition at line 158 of file crmcommon_private.h.

#define PCMK__IPC_VERSION   1

Definition at line 155 of file crmcommon_private.h.

#define pcmk__set_xml_flags	(		xml_priv,
			flags_to_set
	)

Value:

do {                    \
        (xml_priv)->flags = pcmk__set_flags_as(__func__, __LINE__,          \
            LOG_NEVER, "XML", "XML node", (xml_priv)->flags,                \
            (flags_to_set), #flags_to_set);                                 \
    } while (0)

Definition at line 69 of file crmcommon_private.h.

Typedef Documentation

typedef struct pcmk__deleted_xml_s pcmk__deleted_xml_t

typedef struct pcmk__ipc_header_s pcmk__ipc_header_t

typedef struct pcmk__ipc_methods_s pcmk__ipc_methods_t

typedef struct xml_private_s xml_private_t

Enumeration Type Documentation

enum xml_private_flags

Enumerator
xpf_none
xpf_dirty
xpf_deleted
xpf_created
xpf_modified
xpf_tracking
xpf_processed
xpf_skip
xpf_moved
xpf_acl_enabled
xpf_acl_read
xpf_acl_write
xpf_acl_deny
xpf_acl_create
xpf_acl_denied
xpf_lazy

Definition at line 31 of file crmcommon_private.h.

Function Documentation

G_GNUC_INTERNAL void pcmk__apply_acl

(

xmlNode *

xml

)

Definition at line 243 of file acl.c.

G_GNUC_INTERNAL void pcmk__apply_creation_acl	(	xmlNode *	xml,
		bool	check_top
	)

Definition at line 529 of file acl.c.

G_GNUC_INTERNAL void pcmk__buffer_add_char	(	char **	buffer,
		int *	offset,
		int *	max,
		char	c
	)

Definition at line 1988 of file xml.c.

G_GNUC_INTERNAL void pcmk__call_ipc_callback	(	pcmk_ipc_api_t *	api,
		enum pcmk_ipc_event	event_type,
		crm_exit_t	status,
		void *	event_data
	)

Definition at line 144 of file ipc_client.c.

G_GNUC_INTERNAL bool pcmk__check_acl	(	xmlNode *	xml,
		const char *	name,
		enum xml_private_flags	mode
	)

Definition at line 599 of file acl.c.

G_GNUC_INTERNAL pcmk__ipc_methods_t* pcmk__controld_api_methods

(

void

)

Definition at line 244 of file ipc_controld.c.

int pcmk__crm_ipc_is_authentic_process	(	qb_ipcc_connection_t *	qb_ipc,
		int	sock,
		uid_t	refuid,
		gid_t	refgid,
		pid_t *	gotpid,
		uid_t *	gotuid,
		gid_t *	gotgid
	)

Check the authenticity of the IPC socket peer process.

If everything goes well, peer's authenticity is verified by the means of comparing against provided referential UID and GID (either satisfies), and the result of this check can be deduced from the return value. As an exception, detected UID of 0 ("root") satisfies arbitrary provided referential daemon's credentials.

Parameters

[in]	qb_ipc	libqb client connection if available
[in]	sock	IPC related, connected Unix socket to check peer of
[in]	refuid	referential UID to check against
[in]	refgid	referential GID to check against
[out]	gotpid	to optionally store obtained PID of the peer (not available on FreeBSD, special value of 1 used instead, and the caller is required to special case this value respectively)
[out]	gotuid	to optionally store obtained UID of the peer
[out]	gotgid	to optionally store obtained GID of the peer

Returns

Standard Pacemaker return code ie: 0 if it the connection is authentic pcmk_rc_ipc_unauthorized if the connection is not authentic, standard errors.

Note

While this function is tolerant on what constitutes authorized IPC daemon process (its effective user matches UID=0 or refuid, or at least its group matches refgid), either or both (in case of UID=0) mismatches on the expected credentials of such peer process shall be investigated at the caller when value of 1 gets returned there, since higher-than-expected privileges in respect to the expected/intended credentials possibly violate the least privilege principle and may pose an additional risk (i.e. such accidental inconsistency shall be eventually fixed).

Definition at line 1305 of file ipc_client.c.

G_GNUC_INTERNAL int pcmk__element_xpath	(	const char *	prefix,
		xmlNode *	xml,
		char *	buffer,
		int	offset,
		size_t	buffer_size
	)

Definition at line 269 of file xpath.c.

G_GNUC_INTERNAL void pcmk__free_acls

(

GList *

acls

)

Definition at line 46 of file acl.c.

G_GNUC_INTERNAL unsigned int pcmk__ipc_buffer_size

(

unsigned int

max

)

Definition at line 31 of file ipc_common.c.

G_GNUC_INTERNAL void pcmk__mark_xml_attr_dirty

(

xmlAttr *

a

)

Definition at line 174 of file xml.c.

G_GNUC_INTERNAL void pcmk__mark_xml_created

(

xmlNode *

xml

)

Definition at line 156 of file xml.c.

G_GNUC_INTERNAL pcmk__ipc_methods_t* pcmk__pacemakerd_api_methods

(

void

)

Definition at line 189 of file ipc_pacemakerd.c.

G_GNUC_INTERNAL int pcmk__send_ipc_request	(	pcmk_ipc_api_t *	api,
		xmlNode *	request
	)

Definition at line 584 of file ipc_client.c.

G_GNUC_INTERNAL void pcmk__set_xml_doc_flag	(	xmlNode *	xml,
		enum xml_private_flags	flag
	)

Definition at line 118 of file xml.c.

G_GNUC_INTERNAL bool pcmk__tracking_xml_changes	(	xmlNode *	xml,
		bool	lazy
	)

Definition at line 52 of file xml.c.

G_GNUC_INTERNAL void pcmk__unpack_acl	(	xmlNode *	source,
		xmlNode *	target,
		const char *	user
	)

Definition at line 288 of file acl.c.

G_GNUC_INTERNAL bool pcmk__valid_ipc_header

(

const pcmk__ipc_header_t *

header

)

Definition at line 81 of file ipc_common.c.

G_GNUC_INTERNAL bool pcmk__xa_filterable

(

const char *

name

)

Definition at line 252 of file digest.c.

G_GNUC_INTERNAL xmlNode* pcmk__xc_match	(	xmlNode *	root,
		xmlNode *	search_comment,
		bool	exact
	)

Definition at line 2431 of file xml.c.

G_GNUC_INTERNAL void pcmk__xc_update	(	xmlNode *	parent,
		xmlNode *	target,
		xmlNode *	update
	)

Definition at line 2480 of file xml.c.

G_GNUC_INTERNAL void pcmk__xe_log	(	int	log_level,
		const char *	file,
		const char *	function,
		int	line,
		const char *	prefix,
		xmlNode *	data,
		int	depth,
		int	options
	)

Definition at line 1444 of file xml.c.

G_GNUC_INTERNAL void pcmk__xml2text	(	xmlNode *	data,
		int	options,
		char **	buffer,
		int *	offset,
		int *	max,
		int	depth
	)

Definition at line 1871 of file xml.c.

G_GNUC_INTERNAL xmlNode* pcmk__xml_match	(	xmlNode *	haystack,
		xmlNode *	needle,
		bool	exact
	)

Definition at line 370 of file xml.c.

G_GNUC_INTERNAL int pcmk__xml_position	(	xmlNode *	xml,
		enum xml_private_flags	ignore_if_set
	)

Definition at line 315 of file xml.c.

G_GNUC_INTERNAL void pcmk__xml_update	(	xmlNode *	parent,
		xmlNode *	target,
		xmlNode *	update,
		bool	as_diff
	)

Definition at line 2511 of file xml.c.