Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

auth (3erl)

Name

auth - Erlang network authentication server.

Synopsis

Please see following description for synopsis

Description

auth(3)                    Erlang Module Definition                    auth(3)



NAME
       auth - Erlang network authentication server.

DESCRIPTION
       This  module  is deprecated. For a description of the Magic Cookie sys-
       tem, 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).



Ericsson AB                       kernel 8.2                           auth(3)