---
name: "auth"
section: "3erl"
platform: "linux"
package: "erlang-manpages"
version: "1:25.2.3+dfsg-1+deb12u4"
release: "Debian 12 (Bookworm)"
platforms: ["linux"]
url: "https://new.carta.tech/auth/3erl"
---

# auth(3erl)

Erlang network authentication server.

## 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.

## DATA TYPES

```
cookie() = atom()
```

## EXPORTS

```
cookie() -> Cookie
```

Types:

Cookie = cookie()\

Use *erlang:get\_cookie()* in ERTS instead.

```
cookie(TheCookie) -> true
```

Types:

TheCookie = Cookie \| \[Cookie\]\

 The cookie can also be specified as a list with a single atom element.

Cookie = cookie()\

Use *erlang:set\_cookie(node(), Cookie)* in ERTS instead.

```
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).

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)*.