Provides functions for managing authentication with sockets. Usually you’d use this on the Socket to authenticate on connection on the connect function.

There are two main ways to use this module.

1. use Guardian.Phoenix.Socket
2. import Guardian.Phoenix.Socket

You use this function when you want to automatically sign in a socket on connect. The case where authentication information is not provided is not handled so that you can handle it yourself.

defmodule MyApp.UserSocket do
  use Phoenix.Socket
  use Guardian.Phoenix.Socket

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

If you want more control over the authentication of the connection, then you should import Guardian.Phoenix.Socket and use the sign_in function to authenticate.

defmodule MyApp.UserSocket do
  use Phoenix.Socket
  import Guardian.Phoenix.Socket

  def connect(%{"guardian_token" => jwt} = params, socket) do
    case sign_in(socket, jwt) do
      {:ok, authed_socket, guardian_params} ->
        {:ok, authed_socket}
      _ -> :error
    end
  end
end

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