pcmki_acl.h

Go to the documentation of this file.

/*
 * Copyright 2004-2024 the Pacemaker project contributors
 *
 * The version control history for this file may have further details.
 *
 * This source code is licensed under the GNU Lesser General Public License
 * version 2.1 or later (LGPLv2.1+) WITHOUT ANY WARRANTY.
 */
#ifndef PCMK__PCMKI_PCMKI_ACL__H
#define PCMK__PCMKI_PCMKI_ACL__H

#include <crm/common/xml.h>

#ifdef __cplusplus
extern "C" {
#endif

// How ACLs can be displayed (for cibadmin --show-access)
enum pcmk__acl_render_how {
    pcmk__acl_render_none = 0,
    pcmk__acl_render_namespace,
    pcmk__acl_render_text,
    pcmk__acl_render_color,
    pcmk__acl_render_default,
};

// Minimum CIB schema version that can be used to annotate and display ACLs
#define PCMK__COMPAT_ACL_2_MIN_INCL "pacemaker-2.0"

int pcmk__acl_annotate_permissions(const char *cred, const xmlDoc *cib_doc,
                                   xmlDoc **acl_evaled_doc);

int pcmk__acl_evaled_render(xmlDoc *annotated_doc, enum pcmk__acl_render_how,
                            xmlChar **doc_txt_ptr);

#ifdef __cplusplus
}
#endif

#endif // PCMK__PCMKI_PCMKI_ACL__H