@modelprofile.com/authswitch-signin 10.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist_ts_signin/index.d.ts +5 -0
- package/dist_ts_signin/index.js +6 -0
- package/dist_ts_signin/plugins.d.ts +2 -0
- package/dist_ts_signin/plugins.js +4 -0
- package/dist_ts_signin/signin.credential.d.ts +29 -0
- package/dist_ts_signin/signin.credential.js +78 -0
- package/dist_ts_signin/signin.device.d.ts +56 -0
- package/dist_ts_signin/signin.device.js +85 -0
- package/dist_ts_signin/signin.grants.d.ts +195 -0
- package/dist_ts_signin/signin.grants.js +408 -0
- package/dist_ts_signin/signin.interfaces.d.ts +62 -0
- package/dist_ts_signin/signin.interfaces.js +3 -0
- package/dist_ts_signin/signin.protocol.d.ts +93 -0
- package/dist_ts_signin/signin.protocol.js +397 -0
- package/license.md +21 -0
- package/openai-codex-license.txt +201 -0
- package/package.json +37 -0
- package/readme.md +163 -0
- package/third-party-notices.md +34 -0
- package/ts_signin/index.ts +5 -0
- package/ts_signin/plugins.ts +4 -0
- package/ts_signin/readme.md +163 -0
- package/ts_signin/signin.credential.ts +91 -0
- package/ts_signin/signin.device.ts +137 -0
- package/ts_signin/signin.grants.ts +518 -0
- package/ts_signin/signin.interfaces.ts +75 -0
- package/ts_signin/signin.protocol.ts +454 -0
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright 2025 OpenAI
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/package.json
ADDED
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
{
|
|
2
|
+
"author": "Task Venture Capital GmbH",
|
|
3
|
+
"license": "MIT",
|
|
4
|
+
"repository": {
|
|
5
|
+
"type": "git",
|
|
6
|
+
"url": "git+https://code.foss.global/modelprofile.com/authswitch.git"
|
|
7
|
+
},
|
|
8
|
+
"homepage": "https://code.foss.global/modelprofile.com/authswitch",
|
|
9
|
+
"bugs": {
|
|
10
|
+
"url": "https://community.foss.global/"
|
|
11
|
+
},
|
|
12
|
+
"name": "@modelprofile.com/authswitch-signin",
|
|
13
|
+
"version": "10.4.0",
|
|
14
|
+
"type": "module",
|
|
15
|
+
"description": "Sign a ChatGPT account in by device code and keep its grant usable across processes, over a store the caller supplies.",
|
|
16
|
+
"main": "./dist_ts_signin/index.js",
|
|
17
|
+
"types": "./dist_ts_signin/index.d.ts",
|
|
18
|
+
"exports": {
|
|
19
|
+
".": {
|
|
20
|
+
"types": "./dist_ts_signin/index.d.ts",
|
|
21
|
+
"import": "./dist_ts_signin/index.js"
|
|
22
|
+
}
|
|
23
|
+
},
|
|
24
|
+
"dependencies": {},
|
|
25
|
+
"engines": {
|
|
26
|
+
"node": ">=24"
|
|
27
|
+
},
|
|
28
|
+
"sideEffects": false,
|
|
29
|
+
"files": [
|
|
30
|
+
"ts_signin",
|
|
31
|
+
"dist_ts_signin",
|
|
32
|
+
"third-party-notices.md",
|
|
33
|
+
"openai-codex-license.txt",
|
|
34
|
+
"readme.md",
|
|
35
|
+
"license.md"
|
|
36
|
+
]
|
|
37
|
+
}
|
package/readme.md
ADDED
|
@@ -0,0 +1,163 @@
|
|
|
1
|
+
# @modelprofile.com/authswitch-signin
|
|
2
|
+
|
|
3
|
+
Sign a ChatGPT account in by device code, and keep its grant usable for any number of processes that
|
|
4
|
+
share one store. Part of [authswitch](https://code.foss.global/modelprofile.com/authswitch), which runs
|
|
5
|
+
its own sign-ins on this package.
|
|
6
|
+
|
|
7
|
+
## Issue Reporting and Security
|
|
8
|
+
|
|
9
|
+
For reporting bugs, issues, or security vulnerabilities, please visit [community.foss.global/](https://community.foss.global/). This is the central community hub for all issue reporting. Developers who sign and comply with our contribution agreement and go through identification can also get a [code.foss.global/](https://code.foss.global/) account to submit Pull Requests directly.
|
|
10
|
+
|
|
11
|
+
## Install
|
|
12
|
+
|
|
13
|
+
```sh
|
|
14
|
+
pnpm add @modelprofile.com/authswitch-signin
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
The package has no runtime dependencies; it needs Node 24 and the global `fetch`, or a `fetch` you pass.
|
|
18
|
+
|
|
19
|
+
## What it does
|
|
20
|
+
|
|
21
|
+
- **The sign-in protocol** Codex uses: the device code, its poll, the authorization-code exchange, the
|
|
22
|
+
refresh-token grant, the revocation and the claims of the tokens (`requestOpenAiDeviceCode`,
|
|
23
|
+
`pollOpenAiDeviceCodeOnce`, `pollOpenAiDeviceCode`, `exchangeOpenAiDeviceAuthorization`,
|
|
24
|
+
`refreshOpenAiTokens`, `revokeOpenAiRefreshToken`, `parseOpenAiTokenClaims`).
|
|
25
|
+
- **A device sign-in that survives a restart** (`startOpenAiDeviceSignIn`, `pollOpenAiDeviceSignIn`).
|
|
26
|
+
- **A grant manager over a store you supply** (`OpenAiGrantManager`).
|
|
27
|
+
|
|
28
|
+
Every failure has a fixed message. No response body, token, code or header crosses an error, a status or a
|
|
29
|
+
return value other than the credential itself.
|
|
30
|
+
|
|
31
|
+
## A device sign-in any process can finish
|
|
32
|
+
|
|
33
|
+
```typescript
|
|
34
|
+
import {
|
|
35
|
+
pollOpenAiDeviceSignIn,
|
|
36
|
+
startOpenAiDeviceSignIn,
|
|
37
|
+
} from '@modelprofile.com/authswitch-signin';
|
|
38
|
+
|
|
39
|
+
const { prompt, state } = await startOpenAiDeviceSignIn();
|
|
40
|
+
// Show prompt.verificationUrl and prompt.userCode; the code expires at prompt.expiresAt.
|
|
41
|
+
// Keep `state` sealed: its deviceAuthId with its userCode complete the sign-in.
|
|
42
|
+
|
|
43
|
+
const poll = await pollOpenAiDeviceSignIn(state);
|
|
44
|
+
if (poll.status === 'approved') {
|
|
45
|
+
// poll.result.credential is the sign-in; poll.result.account says whose it is.
|
|
46
|
+
} else if (poll.status === 'pending') {
|
|
47
|
+
// Poll again at poll.nextPollAt at the earliest.
|
|
48
|
+
} else {
|
|
49
|
+
// 'expired': start a new sign-in.
|
|
50
|
+
}
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
`startOpenAiDeviceSignIn` stamps the state with `issuedAt` and `expiresAt`. The code lives fifteen
|
|
54
|
+
minutes, the time Codex polls it and tells the person. `pollOpenAiDeviceSignIn` asks once, bounded by the
|
|
55
|
+
time the code has left and by thirty seconds, and answers `expired` without a request once that time is
|
|
56
|
+
up. A malformed state (its shape, or a window longer than fifteen minutes) is refused before anything is
|
|
57
|
+
sent; only shape and window are checked, not where the state came from.
|
|
58
|
+
|
|
59
|
+
The service answers the authorization once. Poll one state from one caller at a time. After `approved`,
|
|
60
|
+
or after a failed exchange, start a new sign-in rather than polling the same state again.
|
|
61
|
+
|
|
62
|
+
## A grant several processes share
|
|
63
|
+
|
|
64
|
+
`OpenAiGrantManager` answers current access for each provider request. It refreshes the tokens when the
|
|
65
|
+
access expires within five minutes, or is older than eight days (Codex's two rules), or the provider
|
|
66
|
+
rejected exactly the current generation.
|
|
67
|
+
|
|
68
|
+
```typescript
|
|
69
|
+
import {
|
|
70
|
+
OpenAiGrantManager,
|
|
71
|
+
type IOpenAiGrantStore,
|
|
72
|
+
} from '@modelprofile.com/authswitch-signin';
|
|
73
|
+
|
|
74
|
+
const store: IOpenAiGrantStore = createMyStore(); // load / create / compareAndSet / remove
|
|
75
|
+
const grants = new OpenAiGrantManager({ store });
|
|
76
|
+
|
|
77
|
+
await grants.create('organization-1', poll.result); // after an approved sign-in
|
|
78
|
+
|
|
79
|
+
const access = await grants.resolveAccess('organization-1', {
|
|
80
|
+
signal,
|
|
81
|
+
rejectedGeneration, // the generation a 401 rejected, if any
|
|
82
|
+
});
|
|
83
|
+
// { accessToken, accountId, isFedrampAccount, expiresAt, generation }
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
That answer is the `resolveAccess` result FlexHarness's
|
|
87
|
+
`createOpenAiChatGptResolvingModelConnection()` takes:
|
|
88
|
+
|
|
89
|
+
```typescript
|
|
90
|
+
const connection = createOpenAiChatGptResolvingModelConnection({
|
|
91
|
+
expectedIdentity: { accountId, isFedrampAccount },
|
|
92
|
+
resolveAccess: ({ signal, rejectedGeneration }) =>
|
|
93
|
+
grants.resolveAccess('organization-1', { signal, rejectedGeneration }),
|
|
94
|
+
});
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
### The store
|
|
98
|
+
|
|
99
|
+
The store is yours. `load` reads a record, `create` inserts a new one, and `compareAndSet` and `remove`
|
|
100
|
+
write only while the record is still at the revision the manager read. Both must compare and write in one
|
|
101
|
+
atomic step, as a database's conditional update does. The record carries the credential. Seal it at rest,
|
|
102
|
+
never log it, and hand it back unchanged. The manager checks every record it reads, and refuses one it would
|
|
103
|
+
not have written with `invalid_record`.
|
|
104
|
+
|
|
105
|
+
### The rules
|
|
106
|
+
|
|
107
|
+
- A refresh token whose outcome is unknown is never sent a second time. Before it sends a refresh, the
|
|
108
|
+
manager stores the grant as `refresh_uncertain`, with an attempt that is given up after sixty seconds.
|
|
109
|
+
A success stores the rotated tokens as `active` and moves the generation on.
|
|
110
|
+
- Every other outcome after the request was handed to `fetch` makes the grant `reauth_required`: a refusal,
|
|
111
|
+
an HTTP error, a lost connection, or the end of the attempt without an answer. So does a refresh that
|
|
112
|
+
answers another workspace or user. Only a new sign-in, through `replace`, repairs it. This is deliberate:
|
|
113
|
+
any answer to a sent refresh other than new tokens, a 429 or a 5xx included, means the refresh token's outcome
|
|
114
|
+
is unknown, and such a token is never sent again. So an outage at OpenAI can require signing in again.
|
|
115
|
+
- A refresh that was never sent keeps the grant `active` and sets `retryAt`, with exponential backoff and
|
|
116
|
+
the service's `Retry-After`. Access that is still valid long enough is served meanwhile. Otherwise the
|
|
117
|
+
call fails with `access_not_fresh`.
|
|
118
|
+
- Within a process, one refresh per grant runs at a time. Across processes, the store's compare-and-set
|
|
119
|
+
decides, and a process that finds another's refresh in flight waits for its outcome. A caller that stops
|
|
120
|
+
waiting (`signal`) leaves the refresh running to its end, so its outcome is recorded.
|
|
121
|
+
- `keepFresh(grantId)` refreshes a grant that is due, for a periodic job that keeps an idle sign-in alive.
|
|
122
|
+
- `remove(grantId)` deletes the grant, then revokes its refresh token at the service. `revocation` is:
|
|
123
|
+
- `confirmed` when the service revoked the current token;
|
|
124
|
+
- `unconfirmed` when a refresh may have replaced that token before;
|
|
125
|
+
- `failed` when the service did not confirm.
|
|
126
|
+
|
|
127
|
+
The grant is removed in every case.
|
|
128
|
+
|
|
129
|
+
Errors are `OpenAiGrantError` with a `code`:
|
|
130
|
+
|
|
131
|
+
- `not_found`
|
|
132
|
+
- `reauth_required`, with `details.reauthReason`: `refresh_failed`, `refresh_interrupted` or
|
|
133
|
+
`identity_changed`
|
|
134
|
+
- `access_not_fresh`, with `details.retryAt`
|
|
135
|
+
- `invalid_argument`
|
|
136
|
+
- `invalid_record`
|
|
137
|
+
- `aborted`
|
|
138
|
+
- `contended`
|
|
139
|
+
|
|
140
|
+
`status(grantId)` answers the grant's state, workspace, plan and times without a token.
|
|
141
|
+
|
|
142
|
+
## License and Legal Information
|
|
143
|
+
|
|
144
|
+
This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the repository license file.
|
|
145
|
+
|
|
146
|
+
The ChatGPT sign-in code is adapted from OpenAI Codex, which is licensed under the Apache License, Version 2.0. Its notices are in `third-party-notices.md` and its license in `openai-codex-license.txt`; both ship with this package.
|
|
147
|
+
|
|
148
|
+
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
|
|
149
|
+
|
|
150
|
+
### Trademarks
|
|
151
|
+
|
|
152
|
+
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH or third parties, and are not included within the scope of the MIT license granted herein.
|
|
153
|
+
|
|
154
|
+
Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines or the guidelines of the respective third-party owners, and any usage must be approved in writing. Third-party trademarks used herein are the property of their respective owners and used only in a descriptive manner, e.g. for an implementation of an API or similar.
|
|
155
|
+
|
|
156
|
+
### Company Information
|
|
157
|
+
|
|
158
|
+
Task Venture Capital GmbH<br>
|
|
159
|
+
Registered at District Court Bremen HRB 35230 HB, Germany
|
|
160
|
+
|
|
161
|
+
For any legal inquiries or further information, please contact us via email at hello@task.vc.
|
|
162
|
+
|
|
163
|
+
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# Third-Party Notices
|
|
2
|
+
|
|
3
|
+
## OpenAI Codex
|
|
4
|
+
|
|
5
|
+
OpenAI Codex
|
|
6
|
+
Copyright 2025 OpenAI
|
|
7
|
+
|
|
8
|
+
The OpenAI ChatGPT device sign-in, authorization-code exchange, refresh-token and
|
|
9
|
+
revocation protocol, the token claims, when a token is refreshed, and the `wham/usage` account rate-limit
|
|
10
|
+
wire contract in `@modelprofile.com/authswitch` and `@modelprofile.com/authswitch-signin` are adapted in
|
|
11
|
+
TypeScript from OpenAI Codex
|
|
12
|
+
(https://github.com/openai/codex). They were first adapted from rust-v0.146.1,
|
|
13
|
+
commit `79b4f03d35962b005b007a015113b38930711665`, and re-verified against
|
|
14
|
+
rust-v0.157.0, commit `00c972ed5d6ff6499317fd41b7f23605b8e6850d`
|
|
15
|
+
(`codex-rs/login/src/device_code_auth.rs`, `codex-rs/login/src/auth/manager.rs`,
|
|
16
|
+
`codex-rs/login/src/auth/revoke.rs`, `codex-rs/login/src/oauth/client.rs`,
|
|
17
|
+
`codex-rs/backend-client/src/client.rs` and the rate-limit models in
|
|
18
|
+
`codex-rs/codex-backend-openapi-models/src/models/`).
|
|
19
|
+
|
|
20
|
+
The adapted files, and their compiled counterparts in `dist_ts/` and
|
|
21
|
+
`dist_ts_signin/`, are marked with a header and contain modifications and
|
|
22
|
+
integration work copyright 2026 Task Venture Capital GmbH:
|
|
23
|
+
|
|
24
|
+
- `ts_signin/signin.protocol.ts`
|
|
25
|
+
- `ts_signin/signin.interfaces.ts`
|
|
26
|
+
- `ts_signin/signin.credential.ts`
|
|
27
|
+
- `ts_signin/signin.device.ts`
|
|
28
|
+
- `ts_signin/signin.grants.ts`
|
|
29
|
+
- `ts/openaiusage.ts`
|
|
30
|
+
- `ts/classes.openaiprovider.ts`
|
|
31
|
+
- `ts/interfaces.openai.ts`
|
|
32
|
+
|
|
33
|
+
OpenAI Codex is licensed under the Apache License, Version 2.0. A verbatim copy
|
|
34
|
+
of the upstream license is distributed in [openai-codex-license.txt](./openai-codex-license.txt).
|
|
@@ -0,0 +1,163 @@
|
|
|
1
|
+
# @modelprofile.com/authswitch-signin
|
|
2
|
+
|
|
3
|
+
Sign a ChatGPT account in by device code, and keep its grant usable for any number of processes that
|
|
4
|
+
share one store. Part of [authswitch](https://code.foss.global/modelprofile.com/authswitch), which runs
|
|
5
|
+
its own sign-ins on this package.
|
|
6
|
+
|
|
7
|
+
## Issue Reporting and Security
|
|
8
|
+
|
|
9
|
+
For reporting bugs, issues, or security vulnerabilities, please visit [community.foss.global/](https://community.foss.global/). This is the central community hub for all issue reporting. Developers who sign and comply with our contribution agreement and go through identification can also get a [code.foss.global/](https://code.foss.global/) account to submit Pull Requests directly.
|
|
10
|
+
|
|
11
|
+
## Install
|
|
12
|
+
|
|
13
|
+
```sh
|
|
14
|
+
pnpm add @modelprofile.com/authswitch-signin
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
The package has no runtime dependencies; it needs Node 24 and the global `fetch`, or a `fetch` you pass.
|
|
18
|
+
|
|
19
|
+
## What it does
|
|
20
|
+
|
|
21
|
+
- **The sign-in protocol** Codex uses: the device code, its poll, the authorization-code exchange, the
|
|
22
|
+
refresh-token grant, the revocation and the claims of the tokens (`requestOpenAiDeviceCode`,
|
|
23
|
+
`pollOpenAiDeviceCodeOnce`, `pollOpenAiDeviceCode`, `exchangeOpenAiDeviceAuthorization`,
|
|
24
|
+
`refreshOpenAiTokens`, `revokeOpenAiRefreshToken`, `parseOpenAiTokenClaims`).
|
|
25
|
+
- **A device sign-in that survives a restart** (`startOpenAiDeviceSignIn`, `pollOpenAiDeviceSignIn`).
|
|
26
|
+
- **A grant manager over a store you supply** (`OpenAiGrantManager`).
|
|
27
|
+
|
|
28
|
+
Every failure has a fixed message. No response body, token, code or header crosses an error, a status or a
|
|
29
|
+
return value other than the credential itself.
|
|
30
|
+
|
|
31
|
+
## A device sign-in any process can finish
|
|
32
|
+
|
|
33
|
+
```typescript
|
|
34
|
+
import {
|
|
35
|
+
pollOpenAiDeviceSignIn,
|
|
36
|
+
startOpenAiDeviceSignIn,
|
|
37
|
+
} from '@modelprofile.com/authswitch-signin';
|
|
38
|
+
|
|
39
|
+
const { prompt, state } = await startOpenAiDeviceSignIn();
|
|
40
|
+
// Show prompt.verificationUrl and prompt.userCode; the code expires at prompt.expiresAt.
|
|
41
|
+
// Keep `state` sealed: its deviceAuthId with its userCode complete the sign-in.
|
|
42
|
+
|
|
43
|
+
const poll = await pollOpenAiDeviceSignIn(state);
|
|
44
|
+
if (poll.status === 'approved') {
|
|
45
|
+
// poll.result.credential is the sign-in; poll.result.account says whose it is.
|
|
46
|
+
} else if (poll.status === 'pending') {
|
|
47
|
+
// Poll again at poll.nextPollAt at the earliest.
|
|
48
|
+
} else {
|
|
49
|
+
// 'expired': start a new sign-in.
|
|
50
|
+
}
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
`startOpenAiDeviceSignIn` stamps the state with `issuedAt` and `expiresAt`. The code lives fifteen
|
|
54
|
+
minutes, the time Codex polls it and tells the person. `pollOpenAiDeviceSignIn` asks once, bounded by the
|
|
55
|
+
time the code has left and by thirty seconds, and answers `expired` without a request once that time is
|
|
56
|
+
up. A malformed state (its shape, or a window longer than fifteen minutes) is refused before anything is
|
|
57
|
+
sent; only shape and window are checked, not where the state came from.
|
|
58
|
+
|
|
59
|
+
The service answers the authorization once. Poll one state from one caller at a time. After `approved`,
|
|
60
|
+
or after a failed exchange, start a new sign-in rather than polling the same state again.
|
|
61
|
+
|
|
62
|
+
## A grant several processes share
|
|
63
|
+
|
|
64
|
+
`OpenAiGrantManager` answers current access for each provider request. It refreshes the tokens when the
|
|
65
|
+
access expires within five minutes, or is older than eight days (Codex's two rules), or the provider
|
|
66
|
+
rejected exactly the current generation.
|
|
67
|
+
|
|
68
|
+
```typescript
|
|
69
|
+
import {
|
|
70
|
+
OpenAiGrantManager,
|
|
71
|
+
type IOpenAiGrantStore,
|
|
72
|
+
} from '@modelprofile.com/authswitch-signin';
|
|
73
|
+
|
|
74
|
+
const store: IOpenAiGrantStore = createMyStore(); // load / create / compareAndSet / remove
|
|
75
|
+
const grants = new OpenAiGrantManager({ store });
|
|
76
|
+
|
|
77
|
+
await grants.create('organization-1', poll.result); // after an approved sign-in
|
|
78
|
+
|
|
79
|
+
const access = await grants.resolveAccess('organization-1', {
|
|
80
|
+
signal,
|
|
81
|
+
rejectedGeneration, // the generation a 401 rejected, if any
|
|
82
|
+
});
|
|
83
|
+
// { accessToken, accountId, isFedrampAccount, expiresAt, generation }
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
That answer is the `resolveAccess` result FlexHarness's
|
|
87
|
+
`createOpenAiChatGptResolvingModelConnection()` takes:
|
|
88
|
+
|
|
89
|
+
```typescript
|
|
90
|
+
const connection = createOpenAiChatGptResolvingModelConnection({
|
|
91
|
+
expectedIdentity: { accountId, isFedrampAccount },
|
|
92
|
+
resolveAccess: ({ signal, rejectedGeneration }) =>
|
|
93
|
+
grants.resolveAccess('organization-1', { signal, rejectedGeneration }),
|
|
94
|
+
});
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
### The store
|
|
98
|
+
|
|
99
|
+
The store is yours. `load` reads a record, `create` inserts a new one, and `compareAndSet` and `remove`
|
|
100
|
+
write only while the record is still at the revision the manager read. Both must compare and write in one
|
|
101
|
+
atomic step, as a database's conditional update does. The record carries the credential. Seal it at rest,
|
|
102
|
+
never log it, and hand it back unchanged. The manager checks every record it reads, and refuses one it would
|
|
103
|
+
not have written with `invalid_record`.
|
|
104
|
+
|
|
105
|
+
### The rules
|
|
106
|
+
|
|
107
|
+
- A refresh token whose outcome is unknown is never sent a second time. Before it sends a refresh, the
|
|
108
|
+
manager stores the grant as `refresh_uncertain`, with an attempt that is given up after sixty seconds.
|
|
109
|
+
A success stores the rotated tokens as `active` and moves the generation on.
|
|
110
|
+
- Every other outcome after the request was handed to `fetch` makes the grant `reauth_required`: a refusal,
|
|
111
|
+
an HTTP error, a lost connection, or the end of the attempt without an answer. So does a refresh that
|
|
112
|
+
answers another workspace or user. Only a new sign-in, through `replace`, repairs it. This is deliberate:
|
|
113
|
+
any answer to a sent refresh other than new tokens, a 429 or a 5xx included, means the refresh token's outcome
|
|
114
|
+
is unknown, and such a token is never sent again. So an outage at OpenAI can require signing in again.
|
|
115
|
+
- A refresh that was never sent keeps the grant `active` and sets `retryAt`, with exponential backoff and
|
|
116
|
+
the service's `Retry-After`. Access that is still valid long enough is served meanwhile. Otherwise the
|
|
117
|
+
call fails with `access_not_fresh`.
|
|
118
|
+
- Within a process, one refresh per grant runs at a time. Across processes, the store's compare-and-set
|
|
119
|
+
decides, and a process that finds another's refresh in flight waits for its outcome. A caller that stops
|
|
120
|
+
waiting (`signal`) leaves the refresh running to its end, so its outcome is recorded.
|
|
121
|
+
- `keepFresh(grantId)` refreshes a grant that is due, for a periodic job that keeps an idle sign-in alive.
|
|
122
|
+
- `remove(grantId)` deletes the grant, then revokes its refresh token at the service. `revocation` is:
|
|
123
|
+
- `confirmed` when the service revoked the current token;
|
|
124
|
+
- `unconfirmed` when a refresh may have replaced that token before;
|
|
125
|
+
- `failed` when the service did not confirm.
|
|
126
|
+
|
|
127
|
+
The grant is removed in every case.
|
|
128
|
+
|
|
129
|
+
Errors are `OpenAiGrantError` with a `code`:
|
|
130
|
+
|
|
131
|
+
- `not_found`
|
|
132
|
+
- `reauth_required`, with `details.reauthReason`: `refresh_failed`, `refresh_interrupted` or
|
|
133
|
+
`identity_changed`
|
|
134
|
+
- `access_not_fresh`, with `details.retryAt`
|
|
135
|
+
- `invalid_argument`
|
|
136
|
+
- `invalid_record`
|
|
137
|
+
- `aborted`
|
|
138
|
+
- `contended`
|
|
139
|
+
|
|
140
|
+
`status(grantId)` answers the grant's state, workspace, plan and times without a token.
|
|
141
|
+
|
|
142
|
+
## License and Legal Information
|
|
143
|
+
|
|
144
|
+
This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the repository license file.
|
|
145
|
+
|
|
146
|
+
The ChatGPT sign-in code is adapted from OpenAI Codex, which is licensed under the Apache License, Version 2.0. Its notices are in `third-party-notices.md` and its license in `openai-codex-license.txt`; both ship with this package.
|
|
147
|
+
|
|
148
|
+
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
|
|
149
|
+
|
|
150
|
+
### Trademarks
|
|
151
|
+
|
|
152
|
+
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH or third parties, and are not included within the scope of the MIT license granted herein.
|
|
153
|
+
|
|
154
|
+
Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines or the guidelines of the respective third-party owners, and any usage must be approved in writing. Third-party trademarks used herein are the property of their respective owners and used only in a descriptive manner, e.g. for an implementation of an API or similar.
|
|
155
|
+
|
|
156
|
+
### Company Information
|
|
157
|
+
|
|
158
|
+
Task Venture Capital GmbH<br>
|
|
159
|
+
Registered at District Court Bremen HRB 35230 HB, Germany
|
|
160
|
+
|
|
161
|
+
For any legal inquiries or further information, please contact us via email at hello@task.vc.
|
|
162
|
+
|
|
163
|
+
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.
|