krb5_address(3)

💖 krb5_address — Heimdal Kerberos 5 address functions 💖

okay so bestie, welcome to krb5_address(3), straight outta the Heimdal Kerberos 5 library ✨ this is the page where we deal with addresses — the whole sockaddr-to-krb5-address pipeline and back again. she's long, she's thorough, and she's lowkey iconic. let's get into it 🫶

---

🎀 SYNOPSIS 🎀

✨ Functions ✨

here's the whole roster, no cap — every single one of them, in order, exactly as the library declares them:

KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_sockaddr2address (krb5_context context, const struct sockaddr *sa, krb5_address *addr)
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_sockaddr2port (krb5_context context, const struct sockaddr *sa, int16_t *port)
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_addr2sockaddr (krb5_context context, const krb5_address *addr, struct sockaddr *sa, krb5_socklen_t *sa_size, int port)
KRB5_LIB_FUNCTION size_t KRB5_LIB_CALL krb5_max_sockaddr_size (void)
KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL krb5_sockaddr_uninteresting (const struct sockaddr *sa)
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_h_addr2sockaddr (krb5_context context, int af, const char *addr, struct sockaddr *sa, krb5_socklen_t *sa_size, int port)
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_h_addr2addr (krb5_context context, int af, const char *haddr, krb5_address *addr)
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_anyaddr (krb5_context context, int af, struct sockaddr *sa, krb5_socklen_t *sa_size, int port)
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_print_address (const krb5_address *addr, char *str, size_t len, size_t *ret_len)
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_parse_address (krb5_context context, const char *string, krb5_addresses *addresses)
KRB5_LIB_FUNCTION int KRB5_LIB_CALL krb5_address_order (krb5_context context, const krb5_address *addr1, const krb5_address *addr2)
KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL krb5_address_compare (krb5_context context, const krb5_address *addr1, const krb5_address *addr2)
KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL krb5_address_search (krb5_context context, const krb5_address *addr, const krb5_addresses *addrlist)
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_free_address (krb5_context context, krb5_address *address)
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_free_addresses (krb5_context context, krb5_addresses *addresses)
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_copy_address (krb5_context context, const krb5_address *inaddr, krb5_address *outaddr)
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_copy_addresses (krb5_context context, const krb5_addresses *inaddr, krb5_addresses *outaddr)
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_append_addresses (krb5_context context, krb5_addresses *dest, const krb5_addresses *source)
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_make_addrport (krb5_context context, krb5_address **res, const krb5_address *addr, int16_t port)
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_address_prefixlen_boundary (krb5_context context, const krb5_address *inaddr, unsigned long prefixlen, krb5_address *low, krb5_address *high)

twenty functions. twenty. she said "here's my whole personality" and honestly? respect 💅

pro tip bestie: notice they all wear the same outfit — KRB5_LIB_FUNCTION and KRB5_LIB_CALL on the outside, and mostly krb5_error_code on the return. a couple of them switch it up though 👀 keep an eye out.

---

🌸 Detailed Description 🌸

(the plot thickens… and yes, this page keeps going, so hold that thought 🦋)

✨ FUNCTION DOCUMENTATION ✨

Okay bestie, buckle up because this is the function-by-function tea ☕. Every single one, no skips. 💅

---

🌸 krb5_addr2sockaddr 🌸

KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_addr2sockaddr (krb5_context context, const krb5_address * addr,
                    struct sockaddr * sa, krb5_socklen_t * sa_size, int port)

krb5_addr2sockaddr sets the struct sockaddr sa from addr and port. The argument sa_size should initially contain the size of the sa, and after the call it will contain the actual length of the address. In case the sa is too small to fit the whole address, up to *sa_size will be stored, and then *sa_size will be set to the required length. 🔥

Parameters

• context — a Kerberos context 💖
• addr — the address to copy from
• sa — the struct sockaddr that will be filled in
• sa_size — pointer to length of sa, and after the call, it will contain the actual length of the address
• port — set port in sa

Returns

Return an error code or 0. Will return KRB5_PROG_ATYPE_NOSUPP in case address type is not supported. 😭

---

krb5_address_compare

KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL
krb5_address_compare (krb5_context context, const krb5_address * addr1,
                      const krb5_address * addr2)

krb5_address_compare compares the addresses addr1 and addr2. Returns TRUE if the two addresses are the same. 👑

Parameters

• context — a Kerberos context
• addr1 — address to compare
• addr2 — address to compare

Returns

Return TRUE if the addresses are the same, FALSE if not.

---

krb5_address_order

KRB5_LIB_FUNCTION int KRB5_LIB_CALL
krb5_address_order (krb5_context context, const krb5_address * addr1,
                    const krb5_address * addr2)

krb5_address_order compares the addresses addr1 and addr2 so that it can be used for sorting addresses. If the addresses are the same address krb5_address_order will return 0. Behaves like memcmp(2). 🦋

Parameters

• context — a Kerberos context
• addr1 — krb5_address to compare
• addr2 — krb5_address to compare

Returns

< 0 if address addr1 is 'less' than addr2. 0 if addr1 and addr2 are the same address, > 0 if addr2 is 'less' than addr1.

---

krb5_address_prefixlen_boundary

KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_address_prefixlen_boundary (krb5_context context,
                                 const krb5_address * inaddr,
                                 unsigned long prefixlen,
                                 krb5_address * low, krb5_address * high)

Calculate the boundary addresses of inaddr/prefixlen and store them in low and high. ✨

Parameters

• context — a Kerberos context
• inaddr — address in prefixlen that the boundary searched
• prefixlen — width of boundary
• low — lowest address
• high — highest address

Returns

Return an error code or 0.

---

krb5_address_search

KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL
krb5_address_search (krb5_context context, const krb5_address * addr,
                     const krb5_addresses * addrlist)

krb5_address_search checks if the address addr is a member of the address set list addrlist. 🔍

Parameters

• context — a Kerberos context.
• addr — address to search for.
• addrlist — list of addresses to look in for addr.

Returns

Return an error code or 0.

---

krb5_anyaddr

KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_anyaddr (krb5_context context, int af, struct sockaddr * sa,
              krb5_socklen_t * sa_size, int port)

krb5_anyaddr fills in a struct sockaddr sa that can be used to bind(2) to. The argument sa_size should initially contain the size of the sa, and after the call, it will contain the actual length of the address. 💅

Parameters

• context — a Kerberos context
• af — address family
• sa — sockaddr
• sa_size — length of sa.
• port — for to fill into sa.

Returns

Return an error code or 0.

---

krb5_append_addresses

KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_append_addresses (krb5_context context, krb5_addresses * dest,
                       const krb5_addresses * source)

krb5_append_addresses adds the set of addresses in source to dest. While copying the addresses, duplicates are also sorted out. 🎀

Parameters

• context — a Kerberos context
• dest — destination of copy operation
• source — addresses that are going to be added to dest

Returns

Return an error code or 0.

---

krb5_copy_address

KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_copy_address (krb5_context context, const krb5_address * inaddr,
                   krb5_address * outaddr)

krb5_copy_address copies the content of address inaddr to outaddr. 🌸

Parameters

• context — a Kerberos context
• inaddr — pointer to source address
• outaddr — pointer to destination address

Returns

Return an error code or 0.

---

krb5_copy_addresses

KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_copy_addresses (krb5_context context, const krb5_addresses * inaddr,
                     krb5_addresses * outaddr)

krb5_copy_addresses copies the content of addresses inaddr to outaddr. 💖

Parameters

• context — a Kerberos context
• inaddr — pointer to source addresses
• outaddr — pointer to destination addresses

Returns

Return an error code or 0.

---

krb5_free_address

KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_free_address (krb5_context context, krb5_address * address)

krb5_free_address frees the data stored in the address that is allocated with any of the krb5_address functions. 🧚

Parameters

• context — a Kerberos context
• address — address to be freed.

Returns

Return an error code or 0.

---

krb5_free_addresses

KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_free_addresses (krb5_context context, krb5_addresses * addresses)

krb5_free_addresses frees the data stored in the address that is allocated with any of the krb5_address functions. 💀

Parameters

• context — a Kerberos context
• addresses — addresses to be freed.

Returns

Return an error code or 0.

---

krb5_h_addr2addr

KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_h_addr2addr (krb5_context context, int af, const char * haddr,
                  krb5_address * addr)

krb5_h_addr2addr works like krb5_h_addr2sockaddr with the exception that it operates on a krb5_address instead of a struct sockaddr. 🌈

Parameters

• context — a Kerberos context
• af — address family
• haddr — host address from struct hostent.
• addr — returned krb5_address.

Returns

Return an error code or 0.

---

krb5_h_addr2sockaddr

KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_h_addr2sockaddr (krb5_context context, int af, const char * addr,
                      struct sockaddr * sa, krb5_socklen_t * sa_size,
                      int port)

krb5_h_addr2sockaddr initializes a struct sockaddr sa from af and the struct hostent (see gethostbyname(3)) h_addr_list component. The argument sa_size should initially contain the size of the sa, and after the call, it will contain the actual length of the address. 🔥

Parameters

• context — a Kerberos context
• af — addresses
• addr — address
• sa — returned struct sockaddr
• sa_size — size of sa
• port — port to set in sa.

Returns

Return an error code or 0.

---

krb5_make_addrport

KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_make_addrport (krb5_context context, krb5_address ** res,
                    const krb5_address * addr, int16_t port)

Create an address of type KRB5_ADDRESS_ADDRPORT from (addr, port). 👑

Parameters

• context — a Kerberos context
• res — built address from addr/port
• addr — address to use
• port — port to use

Returns

Return an error code or 0.

---

krb5_max_sockaddr_size

KRB5_LIB_FUNCTION size_t KRB5_LIB_CALL
krb5_max_sockaddr_size (void)

krb5_max_sockaddr_size returns the max size of the struct sockaddr that the Kerberos library will return. 💅

Returns

Return a size_t of the maximum struct sockaddr.

---

krb5_parse_address

KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_parse_address (krb5_context context, const char * string,
                    krb5_addresses * addresses)

krb5_parse_address returns the resolved hostname in string to the krb5_addresses addresses. 🌐

Parameters

• context — a Kerberos context
• string
• addresses

Returns

Return an error code or 0.

---

krb5_print_address

KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_print_address (const krb5_address * addr, char * str, size_t len,
                    size_t * ret_len)

krb5_print_address prints the address in addr to the string str that has the length len. If ret_len is not NULL, it will be filled with the length of the string if size were unlimited (not including the final NUL). 🖨️

Parameters

• addr — address to be printed
• str — pointer string to print the address into
• len — length that will fit into area pointed to by str.
• ret_len — return length the str.

Returns

Return an error code or 0.

---

krb5_sockaddr2address

KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_sockaddr2address (krb5_context context, const struct sockaddr * sa,
                       krb5_address * addr)

krb5_sockaddr2address stores an address a struct sockaddr sa in the krb5_address addr. 📦

Parameters

• context — a Kerberos context
• sa — a struct sockaddr to extract the address from
• addr — a Kerberos 5 address to store the address in.

Returns

Return an error code or 0.

---

krb5_sockaddr2port

KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_sockaddr2port (krb5_context context, const struct sockaddr * sa,
                    int16_t * port)

krb5_sockaddr2port extracts a port (if possible) from a struct sockaddr. 🔌

Parameters

• context — a Kerberos context
• sa — a struct sockaddr to extract the port from
• port — a pointer to an int16_t to store the port in.

Returns

Return an error code or 0. Will return KRB5_PROG_ATYPE_NOSUPP in case address type is not supported. 😭

---

krb5_sockaddr_uninteresting

KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL
krb5_sockaddr_uninteresting (const struct sockaddr * sa)

krb5_sockaddr_uninteresting returns TRUE for all sa that the Kerberos library thinks are uninteresting. One example are link local addresses. 🙈

Parameters

• sa — pointer to struct sockaddr that might be interesting.

Returns

Return a non-zero for uninteresting addresses.

---

👑 AUTHOR 👑

Generated automatically by Doxygen for Heimdal Kerberos 5 library from the source code. ✨

---

💖 That's the whole vibe, bestie! This iconic page is from Version 7.8.0, dated Tue Nov 15 2022, and it's literally krb5_address(3). Bye! 💖