auth(3erl)

auth(3erl) 💅

Okay bestie, welcome to the Erlang Module Definition for auth — the Erlang network authentication server. 🫶 This page is giving vintage, because the whole module is deprecated, but every detail is still right here. No cap.

NAME 🌸

auth — Erlang network authentication server.

DESCRIPTION 🦋

This module is deprecated. 😭 For a description of the Magic Cookie system, refer to Distributed Erlang in the Erlang Reference Manual. That's the official tea, fr fr.

DATA TYPES 🎀

cookie() = atom()

EXPORTS ✨

cookie() -> Cookie

Types:

Cookie = cookie()

Use erlang:get_cookie() in ERTS instead. That's the replacement, bestie. 💖

cookie(TheCookie) -> true

Types:

TheCookie = Cookie | [Cookie]

The cookie can also be specified as a list with a single atom element. Cute little list moment. 🎀

Cookie = cookie()

Use erlang:set_cookie(node(), Cookie) in ERTS instead. Iconic swap. ✨

is_auth(Node) -> yes | no

Types:

Node = node()

Returns yes if communication with Node is authorized. Notice that a connection to Node is established in this case. Returns no if Node does not exist or communication is not authorized (it has another cookie than auth thinks it has). So dramatic, but that's the rule. 💀

Use net_adm:ping(Node) instead.

node_cookie([Node, Cookie]) -> yes | no

Types:

Node = node()
Cookie = cookie()

Equivalent to node_cookie(Node, Cookie).

node_cookie(Node, Cookie) -> yes | no

Types:

Node = node()
Cookie = cookie()

Sets the magic cookie of Node to Cookie and verifies the status of the authorization. Equivalent to calling erlang:set_cookie(Node, Cookie), followed by auth:is_auth(Node).

---

Signed off with main-character footer energy: Ericsson AB, kernel 8.5.4.2, page auth(3erl). No date line in the footer, bestie — not inventing one. 💜