root/include/pcmki/pcmki_acl.h

/* */

INCLUDED FROM

   1 /*
   2  * Copyright 2004-2023 the Pacemaker project contributors
   3  *
   4  * The version control history for this file may have further details.
   5  *
   6  * This source code is licensed under the GNU Lesser General Public License
   7  * version 2.1 or later (LGPLv2.1+) WITHOUT ANY WARRANTY.
   8  */
   9 #ifndef PCMK__PCMKI_PCMKI_ACL__H
  10 #define PCMK__PCMKI_PCMKI_ACL__H
  11 
  12 #include <crm/common/xml.h>
  13 
  14 // How ACLs can be displayed (for cibadmin --show-access)
  15 enum pcmk__acl_render_how {
  16     pcmk__acl_render_none = 0,
  17     pcmk__acl_render_namespace,
  18     pcmk__acl_render_text,
  19     pcmk__acl_render_color,
  20     pcmk__acl_render_default,
  21 };
  22 
  23 // Minimum CIB schema version that can be used to annotate and display ACLs
  24 #define PCMK__COMPAT_ACL_2_MIN_INCL "pacemaker-2.0"
  25 
  26 /*!
  27  * \brief Annotate CIB with XML namespaces indicating ACL evaluation results
  28  *
  29  * \param[in]  cred            Credential whose ACL perspective to switch to
  30  * \param[in]  cib_doc         CIB XML to annotate
  31  * \param[out] acl_evaled_doc  Where to store annotated CIB XML
  32  *
  33  * \return  A standard Pacemaker return code (pcmk_rc_ok on success,
  34  *          pcmk_rc_already if ACLs were not applicable,
  35  *          pcmk_rc_schema_validation if the validation schema version
  36  *          is unsupported, or EINVAL or ENOMEM when appropriate.
  37  * \note This supports CIBs validated with the pacemaker-2.0 schema or newer.
  38  */
  39 int pcmk__acl_annotate_permissions(const char *cred, const xmlDoc *cib_doc,
  40                                    xmlDoc **acl_evaled_doc);
  41 
  42 /*!
  43  * \internal
  44  * \brief Create a string representation of a CIB showing ACL evaluation results
  45  *
  46  * \param[in,out] annotated_doc  XML annotated by pcmk__acl_annotate_permissions
  47  * \param[in]     how            Desired rendering
  48  * \param[out]    doc_txt_ptr    Where to put the final outcome string
  49  *
  50  * \return A standard Pacemaker return code
  51  *
  52  * \note This function will free \p annotated_doc, which should not be used
  53  *       after calling this function.
  54  * \todo This function could use more extensive testing for resource leaks.
  55  */
  56 int pcmk__acl_evaled_render(xmlDoc *annotated_doc, enum pcmk__acl_render_how,
  57                             xmlChar **doc_txt_ptr);
  58 
  59 #endif

/* */