Module: Seam::Http::Auth

Defined in:
lib/seam/auth.rb,
lib/seam/token.rb

Defined Under Namespace

Classes: SeamInvalidTokenError

Constant Summary collapse

TOKEN_PREFIX = 
"seam_"
ACCESS_TOKEN_PREFIX = 
"seam_at"
JWT_PREFIX = 
"ey"
CLIENT_SESSION_TOKEN_PREFIX = 
"seam_cst"
PUBLISHABLE_KEY_TOKEN_PREFIX = 
"seam_pk"

Class Method Summary collapse

Class Method Details

.access_token?(token) ⇒ Boolean

Returns:

  • (Boolean) 


16
17
18
 
# File 'lib/seam/token.rb', line 16

def self.access_token?(token)
  token.start_with?(ACCESS_TOKEN_PREFIX)
end

.api_key?(token) ⇒ Boolean

Returns:

  • (Boolean) 


28
29
30
31
32
33
34
 
# File 'lib/seam/token.rb', line 28

def self.api_key?(token)
  !client_session_token?(token) &&
    !jwt?(token) &&
    !access_token?(token) &&
    !publishable_key?(token) &&
    seam_token?(token)
end

.client_session_token?(token) ⇒ Boolean

Returns:

  • (Boolean) 


36
37
38
 
# File 'lib/seam/token.rb', line 36

def self.client_session_token?(token)
  token.start_with?(CLIENT_SESSION_TOKEN_PREFIX)
end

.console_session_token?(token) ⇒ Boolean

Returns:

  • (Boolean) 


44
45
46
 
# File 'lib/seam/token.rb', line 44

def self.console_session_token?(token)
  jwt?(token)
end

.get_auth_headers(api_key: nil, personal_access_token: nil, workspace_id: nil) ⇒ Object

Raises:



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/seam/auth.rb', line 15

def self.get_auth_headers(api_key: nil, personal_access_token: nil, workspace_id: nil)
  if Http::Options.seam_http_options_with_api_key?(api_key: api_key, personal_access_token: personal_access_token)
    return get_auth_headers_for_api_key(api_key)
  end

  if Http::Options.seam_http_options_with_personal_access_token?(personal_access_token: personal_access_token, api_key: api_key,
    workspace_id: workspace_id)
    return get_auth_headers_for_personal_access_token(personal_access_token, workspace_id)
  end

  raise Http::Options::SeamInvalidOptionsError.new(
    "Must specify an api_key or personal_access_token. " \
    "Attempted reading configuration from the environment, " \
    "but the environment variable SEAM_API_KEY is not set."
  )
end

.get_auth_headers_for_api_key(api_key) ⇒ Object

Raises:



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/seam/auth.rb', line 32

def self.get_auth_headers_for_api_key(api_key)
  if Auth.client_session_token?(api_key)
    raise SeamInvalidTokenError.new(
      "A Client Session Token cannot be used as an api_key"
    )
  end

  raise SeamInvalidTokenError.new("A JWT cannot be used as an api_key") if Auth.jwt?(api_key)

  raise SeamInvalidTokenError.new("An Access Token cannot be used as an api_key") if Auth.access_token?(api_key)

  if Auth.publishable_key?(api_key)
    raise SeamInvalidTokenError.new(
      "A Publishable Key cannot be used as an api_key"
    )
  end

  unless Auth.seam_token?(api_key)
    raise SeamInvalidTokenError.new(
      "Unknown or invalid api_key format, expected token to start with #{Auth::TOKEN_PREFIX}"
    )
  end

  {"authorization" => "Bearer #{api_key}"}
end

.get_auth_headers_for_multi_workspace_personal_access_token(personal_access_token) ⇒ Object 



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/seam/auth.rb', line 89

def self.get_auth_headers_for_multi_workspace_personal_access_token(personal_access_token)
  if Auth.jwt?(personal_access_token)
    raise SeamInvalidTokenError.new(
      "A JWT cannot be used as a personal_access_token"
    )
  end

  if Auth.client_session_token?(personal_access_token)
    raise SeamInvalidTokenError.new(
      "A Client Session Token cannot be used as a personal_access_token"
    )
  end

  if Auth.publishable_key?(personal_access_token)
    raise SeamInvalidTokenError.new(
      "A Publishable Key cannot be used as a personal_access_token"
    )
  end

  unless Auth.access_token?(personal_access_token)
    raise SeamInvalidTokenError.new(
      "Unknown or invalid personal_access_token format, expected token to start with #{Auth::ACCESS_TOKEN_PREFIX}"
    )
  end

  {"authorization" => "Bearer #{personal_access_token}"}
end

.get_auth_headers_for_personal_access_token(personal_access_token, workspace_id) ⇒ Object 



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/seam/auth.rb', line 58

def self.get_auth_headers_for_personal_access_token(personal_access_token, workspace_id)
  if Auth.jwt?(personal_access_token)
    raise SeamInvalidTokenError.new(
      "A JWT cannot be used as a personal_access_token"
    )
  end

  if Auth.client_session_token?(personal_access_token)
    raise SeamInvalidTokenError.new(
      "A Client Session Token cannot be used as a personal_access_token"
    )
  end

  if Auth.publishable_key?(personal_access_token)
    raise SeamInvalidTokenError.new(
      "A Publishable Key cannot be used as a personal_access_token"
    )
  end

  unless Auth.access_token?(personal_access_token)
    raise SeamInvalidTokenError.new(
      "Unknown or invalid personal_access_token format, expected token to start with #{Auth::ACCESS_TOKEN_PREFIX}"
    )
  end

  {
    "authorization" => "Bearer #{personal_access_token}",
    "seam-workspace" => workspace_id
  }
end

.jwt?(token) ⇒ Boolean

Returns:

  • (Boolean) 


20
21
22
 
# File 'lib/seam/token.rb', line 20

def self.jwt?(token)
  token.start_with?(JWT_PREFIX)
end

.personal_access_token?(token) ⇒ Boolean

Returns:

  • (Boolean) 


48
49
50
 
# File 'lib/seam/token.rb', line 48

def self.personal_access_token?(token)
  access_token?(token)
end

.publishable_key?(token) ⇒ Boolean

Returns:

  • (Boolean) 


40
41
42
 
# File 'lib/seam/token.rb', line 40

def self.publishable_key?(token)
  token.start_with?(PUBLISHABLE_KEY_TOKEN_PREFIX)
end

.seam_token?(token) ⇒ Boolean

Returns:

  • (Boolean) 


24
25
26
 
# File 'lib/seam/token.rb', line 24

def self.seam_token?(token)
  token.start_with?(TOKEN_PREFIX)
end