Class: Kreator::Providers::OpenAIAuth

Inherits:
Object
  • Object
show all
Defined in:
lib/kreator/providers/openai_auth.rb

Defined Under Namespace

Classes: OAuthCallbackServer

Constant Summary collapse

CLIENT_ID = 
"app_EMoamEEZ73f0CkXaXp7hrann"
AUTHORIZE_URL = 
"https://auth.openai.com/oauth/authorize"
DEFAULT_CODEX_HOME = 
File.expand_path("~/.codex")
DEFAULT_REFRESH_URL = 
"https://auth.openai.com/oauth/token"
DEFAULT_REDIRECT_URI = 
"http://localhost:1455/auth/callback"
DEFAULT_LOGIN_TIMEOUT_SECONDS = 
300
REFRESH_INTERVAL_SECONDS = 
8 * 24 * 60 * 60
SCOPE = 
"openid profile email offline_access"
DEFAULT_PI_AUTH_FILE = 
File.expand_path("~/.pi/agent/auth.json")

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(mode:, token:, **options) ⇒ OpenAIAuth

Returns a new instance of OpenAIAuth.



28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/kreator/providers/openai_auth.rb', line 28

def initialize(mode:, token:, **options)
  @mode = mode.to_sym
  @token = token.to_s
  @account_id = options[:account_id]
  @plan_type = options[:plan_type]
  @refresh_token = options[:refresh_token]
  @expires_at = options[:expires_at]
  @auth_file = options[:auth_file]
  @auth_json = options[:auth_json]
  @auth_provider = options[:auth_provider]
end

Instance Attribute Details

#account_id ⇒ Object (readonly)

Returns the value of attribute account_id.



26
27
28
 
# File 'lib/kreator/providers/openai_auth.rb', line 26

def 
  @account_id
end

#auth_file ⇒ Object (readonly)

Returns the value of attribute auth_file.



26
27
28
 
# File 'lib/kreator/providers/openai_auth.rb', line 26

def auth_file
  @auth_file
end

#mode ⇒ Object (readonly)

Returns the value of attribute mode.



26
27
28
 
# File 'lib/kreator/providers/openai_auth.rb', line 26

def mode
  @mode
end

#plan_type ⇒ Object (readonly)

Returns the value of attribute plan_type.



26
27
28
 
# File 'lib/kreator/providers/openai_auth.rb', line 26

def plan_type
  @plan_type
end

#token ⇒ Object (readonly)

Returns the value of attribute token.



26
27
28
 
# File 'lib/kreator/providers/openai_auth.rb', line 26

def token
  @token
end

Class Method Details

.aborted?(signal) ⇒ Boolean

Returns:

  • (Boolean) 


326
327
328
 
# File 'lib/kreator/providers/openai_auth.rb', line 326

def self.aborted?(signal)
  signal.respond_to?(:aborted?) && signal.aborted?
end

.api_key_mode?(auth_mode) ⇒ Boolean

Returns:

  • (Boolean) 


187
188
189
190
 
# File 'lib/kreator/providers/openai_auth.rb', line 187

def self.api_key_mode?(auth_mode)
  normalized = auth_mode.gsub(/[^a-z]/i, "").downcase
  normalized.empty? || normalized == "apikey"
end

.authorization_url(challenge:, state:, redirect_uri:, originator:) ⇒ Object 



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/kreator/providers/openai_auth.rb', line 213

def self.authorization_url(challenge:, state:, redirect_uri:, originator:)
  uri = URI(AUTHORIZE_URL)
  uri.query = URI.encode_www_form(
    "response_type" => "code",
    "client_id" => CLIENT_ID,
    "redirect_uri" => redirect_uri,
    "scope" => SCOPE,
    "code_challenge" => challenge,
    "code_challenge_method" => "S256",
    "state" => state,
    "id_token_add_organizations" => "true",
    "codex_cli_simplified_flow" => "true",
    "originator" => originator
  )
  uri.to_s
end

.base64_url(value) ⇒ Object 



308
309
310
 
# File 'lib/kreator/providers/openai_auth.rb', line 308

def self.base64_url(value)
  [value].pack("m0").tr("+/", "-_").delete("=")
end

.exchange_authorization_code(code, verifier, redirect_uri) ⇒ Object 



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/kreator/providers/openai_auth.rb', line 236

def self.exchange_authorization_code(code, verifier, redirect_uri)
  uri = URI(ENV.fetch("CODEX_REFRESH_TOKEN_URL_OVERRIDE", DEFAULT_REFRESH_URL))
  request = Net::HTTP::Post.new(uri)
  request["Content-Type"] = "application/x-www-form-urlencoded"
  request.set_form_data(
    "grant_type" => "authorization_code",
    "client_id" => CLIENT_ID,
    "code" => code,
    "code_verifier" => verifier,
    "redirect_uri" => redirect_uri
  )

  body = nil
  response = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == "https") do |http|
    http.request(request) do |http_response|
      body = http_response.body.to_s
      http_response
    end
  end
  parsed = JSON.parse(body.to_s)
  unless response.is_a?(Net::HTTPSuccess) && parsed["access_token"] && parsed["refresh_token"]
    message = parsed.dig("error", "message") || parsed["error_description"] || body
    raise Error.new("OpenAI OAuth login failed: #{message}", code: "oauth_login_failed", status: response.code.to_i)
  end

  parsed
rescue JSON::ParserError => e
  raise Error.new("OpenAI OAuth login returned invalid JSON: #{e.message}", code: "invalid_response")
rescue Timeout::Error, Errno::ECONNRESET, Errno::ECONNREFUSED, SocketError => e
  raise Error.new("OpenAI OAuth login failed: #{e.message}", code: "network_error", retryable: true)
end

.find_auth_json(auth_file, codex_home) ⇒ Object 



112
113
114
115
116
117
118
119
120
 
# File 'lib/kreator/providers/openai_auth.rb', line 112

def self.find_auth_json(auth_file, codex_home)
  auth_candidates = auth_file ? [auth_file] : [File.join(codex_home, "auth.json"), DEFAULT_PI_AUTH_FILE]
  auth_candidates.each do |candidate|
    auth_json = read_auth_json(candidate)
    return [auth_json, candidate] if auth_json
  end

  nil
end

.jwt_account_id(claims) ⇒ Object 



203
204
205
206
 
# File 'lib/kreator/providers/openai_auth.rb', line 203

def self.(claims)
  auth_claims = claims["https://api.openai.com/auth"] || {}
  auth_claims["chatgpt_account_id"] || auth_claims["account_id"] || claims["account_id"]
end

.jwt_claims(jwt) ⇒ Object 



192
193
194
195
196
197
198
199
200
201
 
# File 'lib/kreator/providers/openai_auth.rb', line 192

def self.jwt_claims(jwt)
  _header, payload, _signature = jwt.to_s.split(".", 3)
  return {} if payload.to_s.empty?

  payload = payload.tr("-_", "+/")
  payload += "=" * ((4 - (payload.length % 4)) % 4)
  JSON.parse(payload.unpack1("m0"))
rescue ArgumentError, JSON::ParserError
  {}
end

.jwt_plan_type(claims) ⇒ Object 



208
209
210
211
 
# File 'lib/kreator/providers/openai_auth.rb', line 208

def self.jwt_plan_type(claims)
  auth_claims = claims["https://api.openai.com/auth"] || {}
  auth_claims["chatgpt_plan_type"] || claims["chatgpt_plan_type"]
end

.login(auth_file: ENV.fetch("KREATOR_OPENAI_AUTH_FILE", nil), codex_home: ENV.fetch("CODEX_HOME", DEFAULT_CODEX_HOME), open_browser: true, timeout: DEFAULT_LOGIN_TIMEOUT_SECONDS, on_auth: nil, signal: nil) ⇒ Object

rubocop:disable Metrics/ParameterLists



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/kreator/providers/openai_auth.rb', line 54

def self.(
  auth_file: ENV.fetch("KREATOR_OPENAI_AUTH_FILE", nil),
  codex_home: ENV.fetch("CODEX_HOME", DEFAULT_CODEX_HOME),
  open_browser: true,
  timeout: DEFAULT_LOGIN_TIMEOUT_SECONDS,
  on_auth: nil,
  signal: nil
)
  resolved_auth_file = auth_file || File.join(codex_home, "auth.json")
  verifier, challenge = pkce_pair
  state = SecureRandom.hex(16)
  redirect_uri = ENV.fetch("OPENAI_OAUTH_REDIRECT_URI", DEFAULT_REDIRECT_URI)
  originator = ENV.fetch("OPENAI_OAUTH_ORIGINATOR", "kreator")
  authorization_url = authorization_url(challenge: challenge, state: state, redirect_uri: redirect_uri, originator: originator)
  server = OAuthCallbackServer.start(state: state, redirect_uri: redirect_uri)
  browser_opened = open_browser ? open_authorization_url(authorization_url) : false
  on_auth&.call(url: authorization_url, auth_file: resolved_auth_file, browser_opened: browser_opened)
  callback = wait_for_callback(server, timeout, signal)
  raise Error.new("OpenAI OAuth login timed out waiting for browser callback", code: "oauth_login_timeout") unless callback

  raise Error.new("OpenAI OAuth login cancelled", code: "cancelled") if aborted?(signal)

  token_response = exchange_authorization_code(callback.fetch(:code), verifier, redirect_uri)
  write_oauth_credentials(resolved_auth_file, token_response)
ensure
  server&.close
end

.logout(auth_file: ENV.fetch("KREATOR_OPENAI_AUTH_FILE", nil), codex_home: ENV.fetch("CODEX_HOME", DEFAULT_CODEX_HOME)) ⇒ Object

rubocop:enable Metrics/ParameterLists



83
84
85
86
87
88
89
90
91
 
# File 'lib/kreator/providers/openai_auth.rb', line 83

def self.logout(auth_file: ENV.fetch("KREATOR_OPENAI_AUTH_FILE", nil), codex_home: ENV.fetch("CODEX_HOME", DEFAULT_CODEX_HOME))
  path = auth_file || File.join(codex_home, "auth.json")
  auth_json = read_auth_json(path)
  return { removed: false, auth_file: path } unless auth_json

  removed = !auth_json.delete("openai-codex").nil?
  write_auth_json(path, auth_json) if removed
  { removed: removed, auth_file: path }
end

.open_authorization_url(url) ⇒ Object 



287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/kreator/providers/openai_auth.rb', line 287

def self.open_authorization_url(url)
  command = case RbConfig::CONFIG["host_os"]
            when /darwin/i
              ["open", url]
            when /mswin|mingw|cygwin/i
              ["cmd", "/c", "start", "", url]
            else
              ["xdg-open", url]
            end
  system(*command, out: File::NULL, err: File::NULL)
rescue SystemCallError
  false
end

.pi_account_id(credential, jwt_claims) ⇒ Object 



171
172
173
 
# File 'lib/kreator/providers/openai_auth.rb', line 171

def self.(credential, jwt_claims)
  credential["accountId"] || credential["account_id"] || (jwt_claims)
end

.pi_plan_type(credential, jwt_claims) ⇒ Object 



175
176
177
 
# File 'lib/kreator/providers/openai_auth.rb', line 175

def self.pi_plan_type(credential, jwt_claims)
  credential["planType"] || credential["plan_type"] || jwt_plan_type(jwt_claims)
end

.pkce_pair ⇒ Object 



230
231
232
233
234
 
# File 'lib/kreator/providers/openai_auth.rb', line 230

def self.pkce_pair
  verifier = base64_url(SecureRandom.random_bytes(32))
  challenge = base64_url(Digest::SHA256.digest(verifier))
  [verifier, challenge]
end

.read_auth_json(path) ⇒ Object 



179
180
181
182
183
184
185
 
# File 'lib/kreator/providers/openai_auth.rb', line 179

def self.read_auth_json(path)
  return nil if path.to_s.empty? || !File.file?(path)

  JSON.parse(File.read(path))
rescue JSON::ParserError, SystemCallError => e
  raise Error, "failed to read OpenAI auth file #{path}: #{e.message}"
end

.resolve(api_key: nil, auth_file: ENV.fetch("KREATOR_OPENAI_AUTH_FILE", nil), codex_home: ENV.fetch("CODEX_HOME", DEFAULT_CODEX_HOME), allow_oauth: true) ⇒ Object 



40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/kreator/providers/openai_auth.rb', line 40

def self.resolve(api_key: nil, auth_file: ENV.fetch("KREATOR_OPENAI_AUTH_FILE", nil), codex_home: ENV.fetch("CODEX_HOME", DEFAULT_CODEX_HOME), allow_oauth: true)
  api_key_auth = resolve_api_key(api_key)
  return api_key_auth if api_key_auth

  auth_json, auth_file = find_auth_json(auth_file, codex_home)
  return nil unless auth_json && auth_file

  file_api_key_auth = resolve_auth_file_api_key(auth_json, auth_file)
  return file_api_key_auth if file_api_key_auth

  resolve_oauth(auth_json, auth_file, allow_oauth)
end

.resolve_api_key(api_key) ⇒ Object 



102
103
104
105
106
107
108
109
110
 
# File 'lib/kreator/providers/openai_auth.rb', line 102

def self.resolve_api_key(api_key)
  env_api_key = ENV["CODEX_API_KEY"].to_s.strip
  env_api_key = ENV["OPENAI_API_KEY"].to_s.strip if env_api_key.empty?
  resolved_api_key = api_key.to_s.strip
  resolved_api_key = env_api_key if resolved_api_key.empty?
  return nil if resolved_api_key.empty?

  new(mode: :api_key, token: resolved_api_key)
end

.resolve_auth_file_api_key(auth_json, auth_file) ⇒ Object 



122
123
124
125
126
127
128
 
# File 'lib/kreator/providers/openai_auth.rb', line 122

def self.resolve_auth_file_api_key(auth_json, auth_file)
  file_api_key = auth_json["OPENAI_API_KEY"].to_s.strip
  return nil if file_api_key.empty?
  return nil unless api_key_mode?(auth_json["auth_mode"].to_s)

  new(mode: :api_key, token: file_api_key, auth_file: auth_file, auth_json: auth_json)
end

.resolve_codex_oauth(auth_json, auth_file) ⇒ Object 



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/kreator/providers/openai_auth.rb', line 130

def self.resolve_codex_oauth(auth_json, auth_file)
  tokens = auth_json["tokens"] || {}
  access_token = tokens["access_token"].to_s.strip
  return nil if access_token.empty?

  jwt_claims = jwt_claims(access_token)
   = tokens["account_id"] || tokens["accountId"] || (jwt_claims)
  plan_type = jwt_plan_type(jwt_claims)
  new(
    mode: :oauth,
    token: access_token,
    account_id: ,
    plan_type: plan_type,
    refresh_token: tokens["refresh_token"],
    auth_file: auth_file,
    auth_json: auth_json,
    auth_provider: :codex
  )
end

.resolve_oauth(auth_json, auth_file, allow_oauth) ⇒ Object 



93
94
95
96
97
98
99
100
 
# File 'lib/kreator/providers/openai_auth.rb', line 93

def self.resolve_oauth(auth_json, auth_file, allow_oauth)
  return nil unless allow_oauth

  pi_auth = resolve_pi_oauth(auth_json, auth_file)
  return pi_auth.refresh_if_stale if pi_auth

  resolve_codex_oauth(auth_json, auth_file)&.refresh_if_stale
end

.resolve_pi_oauth(auth_json, auth_file) ⇒ Object 



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/kreator/providers/openai_auth.rb', line 150

def self.resolve_pi_oauth(auth_json, auth_file)
  credential = auth_json["openai-codex"]
  return nil unless credential.is_a?(Hash) && credential["type"] == "oauth"

  access_token = credential["access"].to_s.strip
  return nil if access_token.empty?

  jwt_claims = jwt_claims(access_token)
  new(
    mode: :oauth,
    token: access_token,
    account_id: (credential, jwt_claims),
    plan_type: pi_plan_type(credential, jwt_claims),
    refresh_token: credential["refresh"],
    expires_at: credential["expires"],
    auth_file: auth_file,
    auth_json: auth_json,
    auth_provider: :pi
  )
end

.wait_for_callback(server, timeout, signal) ⇒ Object 



312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/kreator/providers/openai_auth.rb', line 312

def self.wait_for_callback(server, timeout, signal)
  deadline = Time.now + timeout

  loop do
    raise Error.new("OpenAI OAuth login cancelled", code: "cancelled") if aborted?(signal)

    remaining = deadline - Time.now
    return nil unless remaining.positive?

    callback = server.wait([remaining, 0.1].min)
    return callback if callback
  end
end

.write_auth_json(path, auth_json) ⇒ Object 



301
302
303
304
305
306
 
# File 'lib/kreator/providers/openai_auth.rb', line 301

def self.write_auth_json(path, auth_json)
  temp_path = "#{path}.tmp"
  FileUtils.mkdir_p(File.dirname(path))
  File.write(temp_path, JSON.pretty_generate(auth_json), mode: "w", perm: 0o600)
  File.rename(temp_path, path)
end

.write_oauth_credentials(path, token_response) ⇒ Object 



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/kreator/providers/openai_auth.rb', line 268

def self.write_oauth_credentials(path, token_response)
  auth_json = read_auth_json(path) || {}
  access_token = token_response.fetch("access_token")
  expires_in = token_response["expires_in"].to_i
  credential = {
    "type" => "oauth",
    "access" => access_token,
    "refresh" => token_response.fetch("refresh_token")
  }
  credential["expires"] = ((Time.now.to_f * 1000) + (expires_in * 1000)).to_i if expires_in.positive?
   = (jwt_claims(access_token))
  plan_type = jwt_plan_type(jwt_claims(access_token))
  credential["accountId"] =  if 
  credential["planType"] = plan_type if plan_type
  auth_json["openai-codex"] = credential
  write_auth_json(path, auth_json)
  resolve(api_key: nil, auth_file: path, allow_oauth: true)
end

Instance Method Details

#oauth? ⇒ Boolean

Returns:

  • (Boolean) 


330
331
332
 
# File 'lib/kreator/providers/openai_auth.rb', line 330

def oauth?
  mode == :oauth
end

#refresh! ⇒ Object 



345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/kreator/providers/openai_auth.rb', line 345

def refresh!
  response = request_token_refresh
  if @auth_provider == :pi
    update_pi_credentials(response)
  else
    update_codex_credentials(response)
  end

  write_auth_json
  self.class.resolve(api_key: nil, auth_file: auth_file, allow_oauth: true)
end

#refresh_if_stale ⇒ Object 



338
339
340
341
342
343
 
# File 'lib/kreator/providers/openai_auth.rb', line 338

def refresh_if_stale
  return self unless refreshable?
  return self unless stale_refresh?

  refresh!
end

#refreshable? ⇒ Boolean

Returns:

  • (Boolean) 


334
335
336
 
# File 'lib/kreator/providers/openai_auth.rb', line 334

def refreshable?
  oauth? && !@refresh_token.to_s.empty? && !auth_file.to_s.empty?
end