path: root/shard/lib/net/auth.ex

defmodule SNet.Auth do
  @moduledoc"""
  Structure for auth values that define if a connection is with an anonymous
  peer or with an authenticated peer.

  Message handlers in shards will receive an `auth` parameter equal to `nil` if the
  connection where the message comes from is not authenticated, or
  `%SNet.Auth{my_pk: my_pk, his_pk: his_pk}` in the case where the connection is authenticated,
  we are known to them as `my_pk` and they are known to us as `his_pk`.
  """

  defstruct [:my_pk, :his_pk]
end