rc_auth(3)

rc_auth(3) 💅

okay bestie, come SIT, we're learning about rc_auth — the radius client library's little authentication queen. 👑 (also hi, the man page name line was literally just rc_auth - with nothing after it, so like… the NAME section is giving mystery. iconic of her honestly.)

---

✨ SYNOPSIS ✨

#include <radcli/radcli.h>

int rc_auth(
    rc_handle    *rh,
    uint32_t      client_port,
    VALUE_PAIR   *send,
    VALUE_PAIR  **received,
    char         *msg
);

---

🌸 DESCRIPTION 🌸

So basically it builds an authentication request for port id nas_port with the value_pairs in send, and then it submits it to a server. That's the whole vibe. Build the request, yeet it at the server, come back with the tea. 🫖✨

---

🎀 PARAMETERS 🎀

• rh — a handle to your parsed configuration. ur little config bestie. 💜
• client_port — (the man page literally gives this one no description… she's mysterious, she's enigmatic, she said no thoughts head empty 🙈)
• send — a VALUE_PAIR array of values, like e.g. PW_USER_NAME. the stuff you're actually asking about. 💌
• received — an allocated array of received values. this is where the server's answer lands. 👀
• msg — must be an array of PW_MAX_MSG_SIZE or NULL; it will contain the concatenation of any PW_REPLY_MESSAGE received. so if the server left u a lil note, it goes here. 💌

---

🦋 STRUCTURES 🦋

okay serious mode for one sec: Avoid using this structure directly. Use the rc_avpair_get_ functions. no cap, do not touch it directly. 💀

struct rc_value_pair {
  char                   name[RC_NAME_LENGTH+1];      // attribute name if known.
  uint64_t               attribute; // attribute numeric value of type rc_attr_id including vendor; use VENDOR() and ATTRID() to separate.
  rc_attr_type           type;      // attribute type.
  uint32_t               lvalue;    // attribute value if type is PW_TYPE_INTEGER, PW_TYPE_DATE or PW_TYPE_IPADDR.
  char                   strvalue[AUTH_STRING_LEN+1];  // contains attribute value in other cases.
  struct rc_value_pair  *next;
  char                   pad[32];       // unused pad
};

and yes bestie, she said it TWICE, so we're saying it twice. the man page double-posted and we respect her for it. 💅

Avoid using this structure directly. Use the rc_avpair_get_ functions.

struct rc_value_pair {
  char                   name[RC_NAME_LENGTH+1];      // attribute name if known.
  uint64_t               attribute; // attribute numeric value of type rc_attr_id including vendor; use VENDOR() and ATTRID() to separate.
  rc_attr_type           type;      // attribute type.
  uint32_t               lvalue;    // attribute value if type is PW_TYPE_INTEGER, PW_TYPE_DATE or PW_TYPE_IPADDR.
  char                   strvalue[AUTH_STRING_LEN+1];  // contains attribute value in other cases.
  struct rc_value_pair  *next;
  char                   pad[32];       // unused pad
};

---

⭐ RETURN VALUE ⭐

When you call her, you get:

• the received value_pairs in received 📥
• messages from the server in msg (if it's non-NULL) 💬
• and as the actual return value:
  • OK_RC (0) on success — slay ✨
  • CHALLENGE_RC (3) on Access-Challenge received — ooooh a plot twist 🌀
  • negative on failure — she said no 😭

---

🌈 SEE ALSO 🌈

radcli.h(3), rc_aaa(3), rc_aaa_ctx(3), rc_aaa_ctx_free(3), rc_aaa_ctx_get_secret(3), rc_aaa_ctx_get_vector(3), rc_aaa_ctx_server(3), rc_acct(3), rc_acct_proxy(3), rc_add_config(3), rc_apply_config(3), rc_auth(3), rc_auth_proxy(3), rc_avpair_add(3), rc_avpair_assign(3), rc_avpair_copy(3), rc_avpair_free(3), rc_avpair_gen(3), rc_avpair_get(3), rc_avpair_get_attr(3), rc_avpair_get_in6(3), rc_avpair_get_raw(3), rc_avpair_get_uint32(3), rc_avpair_insert(3), rc_avpair_log(3), rc_avpair_new(3), rc_avpair_next(3), rc_avpair_parse(3), rc_avpair_remove(3), rc_avpair_tostr(3), rc_buildreq(3), rc_check(3), rc_check_tls(3), rc_conf_int(3), rc_conf_srv(3), rc_conf_str(3), rc_config_free(3), rc_config_init(3), rc_destroy(3), rc_dict_addattr(3), rc_dict_addval(3), rc_dict_addvend(3), rc_dict_findattr(3), rc_dict_findval(3), rc_dict_findvend(3), rc_dict_free(3), rc_dict_getattr(3), rc_dict_getval(3), rc_dict_getvend(3), rc_find_server_addr(3), rc_get_socket_type(3), rc_get_srcaddr(3), rc_getport(3), rc_mksid(3), rc_new(3), rc_openlog(3), rc_own_hostname(3), rc_read_config(3), rc_read_dictionary(3), rc_read_dictionary_from_buffer(3), rc_send_server(3), rc_setdebug(3), rc_test_config(3), rc_tls_fd(3)

go read the whole friend group bestie, they all hang out together 🫶

---

and that's the page!! brought to u by radcli, dated 2023-01-29, filed under rc_auth(3) — mwah, take care of her, she's doing her best 💖✨🎀