forked from PyGithub/PyGithub
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Auth.py
505 lines (392 loc) · 16 KB
/
Auth.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
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
57
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
88
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
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
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
############################ Copyrights and license ############################
# #
# Copyright 2023 Enrico Minack <github@enrico.minack.dev> #
# Copyright 2023 Jirka Borovec <6035284+Borda@users.noreply.github.com> #
# Copyright 2023 Trim21 <trim21.me@gmail.com> #
# Copyright 2023 chantra <chantra@users.noreply.github.com> #
# #
# This file is part of PyGithub. #
# http://pygithub.readthedocs.io/ #
# #
# PyGithub is free software: you can redistribute it and/or modify it under #
# the terms of the GNU Lesser General Public License as published by the Free #
# Software Foundation, either version 3 of the License, or (at your option) #
# any later version. #
# #
# PyGithub is distributed in the hope that it will be useful, but WITHOUT ANY #
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS #
# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more #
# details. #
# #
# You should have received a copy of the GNU Lesser General Public License #
# along with PyGithub. If not, see <http://www.gnu.org/licenses/>. #
# #
################################################################################
import abc
import base64
import time
from abc import ABC
from datetime import datetime, timedelta, timezone
from typing import TYPE_CHECKING, Dict, Optional, Union
import jwt
from requests import utils
from github import Consts
from github.InstallationAuthorization import InstallationAuthorization
from github.Requester import Requester, WithRequester
if TYPE_CHECKING:
from github.GithubIntegration import GithubIntegration
# For App authentication, time remaining before token expiration to request a new one
ACCESS_TOKEN_REFRESH_THRESHOLD_SECONDS = 20
TOKEN_REFRESH_THRESHOLD_TIMEDELTA = timedelta(seconds=ACCESS_TOKEN_REFRESH_THRESHOLD_SECONDS)
# add new implementations of github.Auth.Auth to docs/utilities.rst
class Auth(abc.ABC):
"""
This class is the base class of all authentication methods for Requester.
"""
@property
@abc.abstractmethod
def token_type(self) -> str:
"""
The type of the auth token as used in the HTTP Authorization header, e.g. Bearer or Basic.
:return: token type
"""
@property
@abc.abstractmethod
def token(self) -> str:
"""
The auth token as used in the HTTP Authorization header.
:return: token
"""
class HTTPBasicAuth(Auth, abc.ABC):
@property
@abc.abstractmethod
def username(self) -> str:
"""
The username.
"""
@property
@abc.abstractmethod
def password(self) -> str:
"""
The password.
"""
@property
def token_type(self) -> str:
return "Basic"
@property
def token(self) -> str:
return base64.b64encode(f"{self.username}:{self.password}".encode()).decode("utf-8").replace("\n", "")
class Login(HTTPBasicAuth):
"""
This class is used to authenticate with login and password.
"""
def __init__(self, login: str, password: str):
assert isinstance(login, str)
assert len(login) > 0
assert isinstance(password, str)
assert len(password) > 0
self._login = login
self._password = password
@property
def login(self) -> str:
return self._login
@property
def username(self) -> str:
return self.login
@property
def password(self) -> str:
return self._password
class Token(Auth):
"""
This class is used to authenticate with a single constant token.
"""
def __init__(self, token: str):
assert isinstance(token, str)
assert len(token) > 0
self._token = token
@property
def token_type(self) -> str:
return "token"
@property
def token(self) -> str:
return self._token
class JWT(Auth, ABC):
"""
This class is the base class to authenticate with a JSON Web Token (JWT).
https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-json-web-token-jwt-for-a-github-app
"""
@property
def token_type(self) -> str:
return "Bearer"
class AppAuth(JWT):
"""
This class is used to authenticate as a GitHub App.
https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-as-a-github-app
"""
def __init__(
self,
app_id: Union[int, str],
private_key: str,
jwt_expiry: int = Consts.DEFAULT_JWT_EXPIRY,
jwt_issued_at: int = Consts.DEFAULT_JWT_ISSUED_AT,
jwt_algorithm: str = Consts.DEFAULT_JWT_ALGORITHM,
):
assert isinstance(app_id, (int, str)), app_id
if isinstance(app_id, str):
assert len(app_id) > 0, "app_id must not be empty"
assert isinstance(private_key, str)
assert len(private_key) > 0, "private_key must not be empty"
assert isinstance(jwt_expiry, int), jwt_expiry
assert Consts.MIN_JWT_EXPIRY <= jwt_expiry <= Consts.MAX_JWT_EXPIRY, jwt_expiry
self._app_id = app_id
self._private_key = private_key
self._jwt_expiry = jwt_expiry
self._jwt_issued_at = jwt_issued_at
self._jwt_algorithm = jwt_algorithm
@property
def app_id(self) -> Union[int, str]:
return self._app_id
@property
def private_key(self) -> str:
return self._private_key
@property
def token(self) -> str:
return self.create_jwt()
def get_installation_auth(
self,
installation_id: int,
token_permissions: Optional[Dict[str, str]] = None,
requester: Optional[Requester] = None,
) -> "AppInstallationAuth":
"""
Creates a github.Auth.AppInstallationAuth instance for an installation.
:param installation_id: installation id
:param token_permissions: optional permissions
:param requester: optional requester with app authentication
:return:
"""
return AppInstallationAuth(self, installation_id, token_permissions, requester)
def create_jwt(self, expiration: Optional[int] = None) -> str:
"""
Create a signed JWT
https://docs.github.com/en/developers/apps/building-github-apps/authenticating-with-github-apps#authenticating-as-a-github-app
:return string: jwt
"""
if expiration is not None:
assert isinstance(expiration, int), expiration
assert Consts.MIN_JWT_EXPIRY <= expiration <= Consts.MAX_JWT_EXPIRY, expiration
now = int(time.time())
payload = {
"iat": now + self._jwt_issued_at,
"exp": now + (expiration if expiration is not None else self._jwt_expiry),
"iss": self._app_id,
}
encrypted = jwt.encode(payload, key=self.private_key, algorithm=self._jwt_algorithm)
if isinstance(encrypted, bytes):
return encrypted.decode("utf-8")
return encrypted
class AppAuthToken(JWT):
"""
This class is used to authenticate as a GitHub App with a single constant JWT.
https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-as-a-github-app
"""
def __init__(self, token: str):
assert isinstance(token, str)
assert len(token) > 0
self._token = token
@property
def token(self) -> str:
return self._token
class AppInstallationAuth(Auth, WithRequester["AppInstallationAuth"]):
"""
This class is used to authenticate as a GitHub App Installation.
https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-as-a-github-app-installation
"""
# used to fetch live access token when calling self.token
__integration: Optional["GithubIntegration"] = None
__installation_authorization: Optional[InstallationAuthorization] = None
def __init__(
self,
app_auth: AppAuth,
installation_id: int,
token_permissions: Optional[Dict[str, str]] = None,
requester: Optional[Requester] = None,
):
super().__init__()
assert isinstance(app_auth, AppAuth), app_auth
assert isinstance(installation_id, int), installation_id
assert token_permissions is None or isinstance(token_permissions, dict), token_permissions
self._app_auth = app_auth
self._installation_id = installation_id
self._token_permissions = token_permissions
if requester is not None:
self.withRequester(requester)
def withRequester(self, requester: Requester) -> "AppInstallationAuth":
super().withRequester(requester.withAuth(self._app_auth))
# imported here to avoid circular import
from github.GithubIntegration import GithubIntegration
self.__integration = GithubIntegration(**self.requester.kwargs)
return self
@property
def app_id(self) -> Union[int, str]:
return self._app_auth.app_id
@property
def private_key(self) -> str:
return self._app_auth.private_key
@property
def installation_id(self) -> int:
return self._installation_id
@property
def token_permissions(self) -> Optional[Dict[str, str]]:
return self._token_permissions
@property
def token_type(self) -> str:
return "token"
@property
def token(self) -> str:
if self.__installation_authorization is None or self._is_expired:
self.__installation_authorization = self._get_installation_authorization()
return self.__installation_authorization.token
@property
def _is_expired(self) -> bool:
assert self.__installation_authorization is not None
token_expires_at = self.__installation_authorization.expires_at - TOKEN_REFRESH_THRESHOLD_TIMEDELTA
return token_expires_at < datetime.now(timezone.utc)
def _get_installation_authorization(self) -> InstallationAuthorization:
assert self.__integration is not None, "Method withRequester(Requester) must be called first"
return self.__integration.get_access_token(
self._installation_id,
permissions=self._token_permissions,
)
class AppUserAuth(Auth, WithRequester["AppUserAuth"]):
"""
This class is used to authenticate as a GitHub App on behalf of a user.
https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user
"""
_client_id: str
_client_secret: str
_token: str
_type: str
_scope: Optional[str]
_expires_at: Optional[datetime]
_refresh_token: Optional[str]
_refresh_expires_at: Optional[datetime]
# imported here to avoid circular import
from github.ApplicationOAuth import ApplicationOAuth
__app: ApplicationOAuth
def __init__(
self,
client_id: str,
client_secret: str,
token: str,
token_type: Optional[str] = None,
expires_at: Optional[datetime] = None,
refresh_token: Optional[str] = None,
refresh_expires_at: Optional[datetime] = None,
requester: Optional[Requester] = None,
) -> None:
super().__init__()
assert isinstance(client_id, str)
assert len(client_id) > 0
assert isinstance(client_secret, str)
assert len(client_secret) > 0
assert isinstance(token, str)
assert len(token) > 0
if token_type is not None:
assert isinstance(token_type, str)
assert len(token_type) > 0
assert isinstance(token, str)
if token_type is not None:
assert isinstance(token_type, str)
assert len(token_type) > 0
if expires_at is not None:
assert isinstance(expires_at, datetime)
if refresh_token is not None:
assert isinstance(refresh_token, str)
assert len(refresh_token) > 0
if refresh_expires_at is not None:
assert isinstance(refresh_expires_at, datetime)
self._client_id = client_id
self._client_secret = client_secret
self._token = token
self._type = token_type or "bearer"
self._expires_at = expires_at
self._refresh_token = refresh_token
self._refresh_expires_at = refresh_expires_at
if requester is not None:
self.withRequester(requester)
@property
def token_type(self) -> str:
return self._type
@property
def token(self) -> str:
if self._is_expired:
self._refresh()
return self._token
def withRequester(self, requester: Requester) -> "AppUserAuth":
super().withRequester(requester.withAuth(None))
# imported here to avoid circular import
from github.ApplicationOAuth import ApplicationOAuth
self.__app = ApplicationOAuth(
# take requester given to super().withRequester, not given to this method
super().requester,
headers={},
attributes={
"client_id": self._client_id,
"client_secret": self._client_secret,
},
completed=False,
)
return self
@property
def _is_expired(self) -> bool:
return self._expires_at is not None and self._expires_at < datetime.now(timezone.utc)
def _refresh(self) -> None:
if self._refresh_token is None:
raise RuntimeError("Cannot refresh expired token because no refresh token has been provided")
if self._refresh_expires_at is not None and self._refresh_expires_at < datetime.now(timezone.utc):
raise RuntimeError("Cannot refresh expired token because refresh token also expired")
# refresh token
token = self.__app.refresh_access_token(self._refresh_token)
# update this auth
self._token = token.token
self._type = token.type
self._scope = token.scope
self._expires_at = token.expires_at
self._refresh_token = token.refresh_token
self._refresh_expires_at = token.refresh_expires_at
@property
def expires_at(self) -> Optional[datetime]:
return self._expires_at
@property
def refresh_token(self) -> Optional[str]:
return self._refresh_token
@property
def refresh_expires_at(self) -> Optional[datetime]:
return self._refresh_expires_at
class NetrcAuth(HTTPBasicAuth, WithRequester["NetrcAuth"]):
"""
This class is used to authenticate via .netrc.
"""
def __init__(self) -> None:
super().__init__()
self._login: Optional[str] = None
self._password: Optional[str] = None
@property
def username(self) -> str:
return self.login
@property
def login(self) -> str:
assert self._login is not None, "Method withRequester(Requester) must be called first"
return self._login
@property
def password(self) -> str:
assert self._password is not None, "Method withRequester(Requester) must be called first"
return self._password
def withRequester(self, requester: Requester) -> "NetrcAuth":
super().withRequester(requester)
auth = utils.get_netrc_auth(requester.base_url, raise_errors=True)
if auth is None:
raise RuntimeError(f"Could not get credentials from netrc for host {requester.hostname}")
self._login, self._password = auth
return self