This module "replace" the _csrf_token generated by Phoenix, if you can't use it (mainly because of caching), to recognize the current authenticated user in channels and, by extension, live view since access to session through websocket rely on this _csrf_token. To do so, this module provides a controller to deliver short lived ciphered and signed token which you request in Javascript (ajax is the main way) and send it back to the server for the websocket connection. Then, Haytni will set the current user for the websocket when you call connect/4 from your Phoenix.Socket.connect/3 callback (channels) and mount_user/4 from your c:Phoenix.LiveView.mount/3 (live view).

Configuration:

• remote_ip_header (default: nil): if a proxy in front of phoenix follows you the IP address of the client through a specific header, explicit it here. For example, with nginx configured with proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;, set remote_ip_header: "x-forwarded-for"

• token_validity (default: {2, :minute}): duration of generated token. You should keep it as short as possible (not more than few minutes) since these tokens are intended to be used right after they were requested

• socket_id (default: nil): a function to resolve a user into a socket's name. This function, from a module (your Haytni's stack) and a user, should return a string (binary) that identify a socket, the same value returned by your Phoenix.Socket.id/1 callback

  stack Haytni.LiveViewPlugin,
    socket_id: nil,
    token_validity: {2, :minute}
    remote_ip_header: nil,

Routes: haytni_<scope>_token_path (action: create): default path is "/token" but you can override it by the :token_path option when calling YourApp.Haytni.routes/1 from your router