pcmki_acl.h

Go to the documentation of this file.

/*
 * Copyright 2004-2021 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>

enum pcmk__acl_cred_type {
    pcmk__acl_cred_unset = 0,
    pcmk__acl_cred_user,
    /* XXX no proper support for groups yet */
};

enum pcmk__acl_render_how {
    pcmk__acl_render_namespace = 1,
    pcmk__acl_render_text,
    pcmk__acl_render_color,
};

/*
 * Version compatibility tracking incl. open-ended intervals for occasional
 * bumps (to avoid hard to follow open-coding throughout).  Grouped by context.
 */

/* Schema version vs. evaluate-as-namespace-annotations-per-credentials */

#define PCMK__COMPAT_ACL_2_MIN_INCL "pacemaker-2.0"

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

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

#endif