Provides functions for managing authentication with sockets.

This module mostly provides convenience functions for storing tokens, claims and resources on the socket assigns.

The main functions you'll be interested in are:

• Guardian.Phoenix.Socket.authenticated? - check if the socket has been authenticated
• Guardian.Phoenix.Socket.authenticate - Sign in a resource to a socket. Similar to Guardian.Plug.authenticate

Getters

Once you're authenticated with your socket, you can use the getters to fetch information about the authenticated resource for the socket.

• Guardian.Phoenix.Socket.current_claims
• Guardian.Phoenix.Socket.current_token
• Guardian.Phoenix.Socket.current_resource

These are the usual functions you'll want to use when dealing with authentication on sockets.

There is a bit of a difference between the usual Guardian.Plug.sign_in and the socket one. The socket authenticate receives a token and signs in from that. Please note that this is mere sugar on the underlying Guardian functions.

As an example:

defmodule MyApp.UserSocket do
  use Phoenix.Socket

  def connect(%{"token" => token}, socket) do
    case Guardian.Phoenix.Socket.authenticate(socket, MyApp.Guardian, token) do
      {:ok, authed_socket} ->
        {:ok, authed_socket}
      {:error, _} -> :error
    end
  end

  # This function will be called when there was no authentication information
  def connect(_params, socket) do
    :error
  end
end

If you want to authenticate on the join of a channel, you can import this module and use the authenticate function as normal.