This repository was archived by the owner on May 22, 2021. It is now read-only.
Repository navigation
Expand file tree
/
Copy pathapps.py
More file actions
190 lines (144 loc) · 5.85 KB
/
Copy pathapps.py
File metadata and controls
190 lines (144 loc) · 5.85 KB
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
"""Module containing helpers for dealing with GitHub Apps.
https://developer.github.com/apps/building-github-apps/
"""
import time
from jwcrypto import jwk
from jwcrypto import jwt
from . import models
from . import users
TEN_MINUTES_AS_SECONDS = 10 * 60
DEFAULT_JWT_TOKEN_EXPIRATION = TEN_MINUTES_AS_SECONDS
APP_PREVIEW_HEADERS = {"Accept": "application/vnd.github.machine-man-preview+json"}
class App(models.GitHubCore):
"""An object representing a GitHub App.
.. versionadded:: 1.2.0
.. seealso::
`GitHub Apps`_
Documentation for Apps on GitHub
`GitHub Apps API Documentation`_
API documentation of what's available about an App.
This object has the following attributes:
.. attribute:: created_at
A :class:`~datetime.datetime` object representing the day and time
the App was created.
.. attribute:: description
The description of the App provided by the owner.
.. attribute:: external_url
The URL provided for the App by the owner.
.. attribute:: html_url
The HTML URL provided for the App by the owner.
.. attribute:: id
The unique identifier for the App. This is useful in cases where you
may want to authenticate either as an App or as a specific
installation of an App.
.. attribute:: name
The display name of the App that the user sees.
.. attribute:: node_id
A base64-encoded blob returned by the GitHub API for who knows what
reason.
.. attribute:: owner
A :class:`~github4.users.ShortUser` object representing the GitHub
user who owns the App.
github4
.. attribute:: updated_at
A :class:`~datetime.datetime` object representing the day and time
the App was last updated.
.. _GitHub Apps:
https://developer.github.com/apps/
.. _GitHub Apps API Documentation:
https://developer.github.com/v3/apps/
"""
CUSTOM_HEADERS = {"Accept": "application/vnd.github.machine-man-preview+json"}
def _update_attributes(self, json):
self.created_at = self._strptime(json["created_at"])
self.description = json["description"]
self.external_url = json["external_url"]
self.html_url = json["html_url"]
self.id = json["id"]
self.name = json["name"]
self.node_id = json["node_id"]
self.owner = users.ShortUser(json["owner"], self)
self.updated_at = self._strptime(json["updated_at"])
_, slug = json["html_url"].rsplit("/", 1)
self._api = self.url = self._build_url("apps", slug)
def _repr(self):
return '<App ["{}" by {}]>'.format(self.name, str(self.owner))
class Installation(models.GitHubCore):
"""An installation of a GitHub App either on a User or Org.
.. versionadded:: 1.2.0
This has the following attributes:
.. attribute:: access_tokens_url
.. attribute:: account
.. attribute:: app_id
.. attribute:: created_at
.. attribute:: events
.. attribute:: html_url
.. attribute:: id
.. attribute:: permissions
.. attribute:: repositories_url
.. attribute:: repository_selection
.. attribute:: single_file_name
.. attribute:: target_id
.. attribute:: target_type
.. attribute:: updated_at
"""
def _update_attributes(self, json):
self.access_tokens_url = json["access_tokens_url"]
self.account = json["account"]
self.app_id = json["app_id"]
self.created_at = self._strptime(json["created_at"])
self.events = json["events"]
self.html_url = json["html_url"]
self.id = json["id"]
self.permissions = json["permissions"]
self.repositories_url = json["repositories_url"]
self.repository_selection = json["repository_selection"]
self.single_file_name = json["single_file_name"]
self.target_id = json["target_id"]
self.target_type = json["target_type"]
self.updated_at = self._strptime(json["updated_at"])
def _load_private_key(pem_key_bytes):
return jwk.JWK.from_pem(pem_key_bytes)
def create_token(private_key_pem, app_id, expire_in=TEN_MINUTES_AS_SECONDS):
"""Create an encrypted token for the specified App.
:param bytes private_key_pem:
The bytes of the private key for this GitHub Application.
:param int app_id:
The integer identifier for this GitHub Application.
:param int expire_in:
The length in seconds for this token to be valid for.
Default: 600 seconds (10 minutes)
:returns:
Serialized encrypted token.
:rtype:
text
"""
if not isinstance(private_key_pem, bytes):
raise ValueError('"private_key_pem" parameter must be byte-string')
key = _load_private_key(private_key_pem)
now = int(time.time())
token = jwt.JWT(
header={"alg": "RS256"},
claims={"iat": now, "exp": now + expire_in, "iss": app_id},
algs=["RS256"],
)
token.make_signed_token(key)
return token.serialize()
def create_jwt_headers(private_key_pem, app_id, expire_in=DEFAULT_JWT_TOKEN_EXPIRATION):
"""Create an encrypted token for the specified App.
:param bytes private_key_pem:
The bytes of the private key for this GitHub Application.
:param int app_id:
The integer identifier for this GitHub Application.
:param int expire_in:
The length in seconds for this token to be valid for.
Default: 600 seconds (10 minutes)
:returns:
Dictionary of headers for retrieving a token from a JWT.
:rtype:
dict
"""
jwt_token = create_token(private_key_pem, app_id, expire_in)
headers = {"Authorization": "Bearer {}".format(jwt_token)}
headers.update(APP_PREVIEW_HEADERS)
return headers