KRB5PLUGIN_KUSEROK_FTABLE_DESC(3)

πŸ“¦
version 7.8.0 Β· 2 versions
, in alpine 3.22, alpine 3.23, alpine 3.24, epel 10, epel 9, fedora 43, fedora 44

✨ NAME ✨

krb5plugin_kuserok_ftable_desc β€” bestie, this is the description of the krb5_kuserok(3) plugin facility πŸ’– (yes, the manual page name is krb5plugin...table_desc(3), from the Heimdal Kerberos 5 library, and it's lowkey iconic).


πŸ“š SYNOPSIS πŸ“š

#include <kuserok_plugin.h>

πŸ’… Detailed Description πŸ’…

Okay so, plot twist: this is the description of the krb5_kuserok(3) plugin facility. That's the whole vibe. πŸ¦‹

The way that krb5_kuserok(3) works is that it's pluggable, periodt. The plugin is named KRB5_PLUGIN_KUSEROK ('krb5_plugin_kuserok'), and it has a single minor version, KRB5_PLUGIN_KUSEROK_VERSION_0 (0). One version, no drama. ✨

The plugin for krb5_kuserok(3) is made of a data symbol that references a structure of type krb5plugin_kuserok_ftable, and that struct has four fields:

πŸŽ€ Parameters πŸŽ€

  • init β€” the plugin initialization function (go check out krb5-plugin(7), iykyk πŸ‘‘)
  • minor_version β€” the plugin minor version number (0)
  • fini β€” the plugin finalization function
  • kuserok β€” the plugin kuserok function

The kuserok field is the main character here: it's the plugin entry point that does the traditional kuserok operation however the plugin feels like doing it. It gets invoked in no particular order relative to other kuserok plugins, but it has a 'rule' argument that tells it which plugin is supposed to act on the rule. And bestie, listen: the plugin kuserok function must return KRB5_PLUGIN_NO_HANDLE if the rule is not applicable to it. No cap. 🫢

The plugin kuserok function has the following arguments, in this exact order:

  1. plug_ctx, the context value output by the plugin's init function
  2. context, a krb5_context
  3. rule, the kuserok rule being evaluated (from krb5.conf(5))
  4. flags
  5. k5login_dir, the configured location of k5login per-user files, if any
  6. luser, name of the local user account to which principal is attempting to access.
  7. principal, the krb5_principal trying to access the luser account
  8. result, a krb5_boolean pointer where the plugin will output its result

🌸 Author 🌸

Generated automatically by Doxygen for Heimdal Kerberos 5 library from the source code. So not a human author, just Doxygen doing its little automated slay πŸ’€βœ¨


Version 7.8.0 β€” Tue Nov 15 2022 🌈 that's the tea, bestie, that's the source and the date, and this manual page (krb5plugin...table_desc(3), Heimdal Kerberos 5 library) is officially wrapped. go forth and plug in those kuserok plugins responsibly πŸŽ€πŸ’–πŸ¦‹

πŸ“¦ where this page comes from