-
Notifications
You must be signed in to change notification settings - Fork 10
Expand file tree
/
Copy pathgitlab.py
More file actions
334 lines (300 loc) · 13.5 KB
/
gitlab.py
File metadata and controls
334 lines (300 loc) · 13.5 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
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
import os
import sys
from dataclasses import dataclass
from typing import Optional, Union
import requests
from socketsecurity import USER_AGENT
from socketsecurity.core import log
from socketsecurity.core.classes import Comment
from socketsecurity.core.scm_comments import Comments
from socketsecurity.socketcli import CliClient
@dataclass
class GitlabConfig:
"""Configuration from GitLab environment variables"""
commit_sha: str
api_url: str
project_dir: str
mr_source_branch: Optional[str]
mr_iid: Optional[str]
mr_project_id: Optional[str]
commit_message: str
default_branch: str
project_name: str
pipeline_source: str
commit_author: str
token: str
repository: str
is_default_branch: bool
headers: dict
@classmethod
def from_env(cls) -> 'GitlabConfig':
token = os.getenv('GITLAB_TOKEN')
if not token:
log.error("Unable to get GitLab API Token from GITLAB_TOKEN")
sys.exit(2)
project_name = os.getenv('CI_PROJECT_NAME', '')
if "/" in project_name:
project_name = project_name.rsplit("/")[1]
mr_source_branch = os.getenv('CI_MERGE_REQUEST_SOURCE_BRANCH_NAME')
default_branch = os.getenv('CI_DEFAULT_BRANCH', '')
# Determine which authentication pattern to use
headers = cls._get_auth_headers(token)
# Prefer source branch SHA (real commit) over CI_COMMIT_SHA which
# may be a synthetic merge-result commit in merged-results pipelines.
commit_sha = (
os.getenv('CI_MERGE_REQUEST_SOURCE_BRANCH_SHA') or
os.getenv('CI_COMMIT_SHA', '')
)
return cls(
commit_sha=commit_sha,
api_url=os.getenv('CI_API_V4_URL', ''),
project_dir=os.getenv('CI_PROJECT_DIR', ''),
mr_source_branch=mr_source_branch,
mr_iid=os.getenv('CI_MERGE_REQUEST_IID'),
mr_project_id=os.getenv('CI_MERGE_REQUEST_PROJECT_ID'),
commit_message=os.getenv('CI_COMMIT_MESSAGE', ''),
default_branch=default_branch,
project_name=project_name,
pipeline_source=os.getenv('CI_PIPELINE_SOURCE', ''),
commit_author=os.getenv('CI_COMMIT_AUTHOR', ''),
token=token,
repository=project_name,
is_default_branch=(mr_source_branch == default_branch if mr_source_branch else False),
headers=headers
)
@staticmethod
def _get_auth_headers(token: str) -> dict:
"""
Determine the appropriate authentication headers for GitLab API.
GitLab supports two authentication patterns:
1. Bearer token (OAuth 2.0 tokens, personal access tokens with api scope)
2. Private token (personal access tokens)
Logic for token type determination:
- CI_JOB_TOKEN: Always use Bearer (GitLab CI job token)
- Tokens starting with 'glpat-': Personal access tokens, try Bearer first
- OAuth tokens: Use Bearer
- Other tokens: Use PRIVATE-TOKEN as fallback
"""
base_headers = {
'User-Agent': USER_AGENT,
"accept": "application/json"
}
# Check if this is a GitLab CI job token
if token == os.getenv('CI_JOB_TOKEN'):
log.debug("Using Bearer authentication for GitLab CI job token")
return {
**base_headers,
'Authorization': f"Bearer {token}"
}
# Check for personal access token pattern
if token.startswith('glpat-'):
log.debug("Using Bearer authentication for GitLab personal access token")
return {
**base_headers,
'Authorization': f"Bearer {token}"
}
# Check for OAuth token pattern (typically longer and alphanumeric)
if len(token) > 40 and token.isalnum():
log.debug("Using Bearer authentication for potential OAuth token")
return {
**base_headers,
'Authorization': f"Bearer {token}"
}
# Default to PRIVATE-TOKEN for other token types
log.debug("Using PRIVATE-TOKEN authentication for GitLab token")
return {
**base_headers,
'PRIVATE-TOKEN': f"{token}"
}
class Gitlab:
def __init__(self, client: CliClient, config: Optional[GitlabConfig] = None):
self.config = config or GitlabConfig.from_env()
self.client = client
def _request_with_fallback(self, **kwargs):
"""
Make a request with automatic fallback between Bearer and PRIVATE-TOKEN authentication.
This provides robustness when the initial token type detection is incorrect.
"""
try:
# Try the initial request with the configured headers
return self.client.request(**kwargs)
except requests.exceptions.HTTPError as e:
# Check if this is an authentication error (401)
if e.response and e.response.status_code == 401:
log.debug(f"Authentication failed with initial headers, trying fallback method")
# Determine the fallback headers
original_headers = kwargs.get('headers', self.config.headers)
fallback_headers = self._get_fallback_headers(original_headers)
if fallback_headers and fallback_headers != original_headers:
log.debug("Retrying request with fallback authentication method")
kwargs['headers'] = fallback_headers
return self.client.request(**kwargs)
# Re-raise the original exception if it's not an auth error or fallback failed
raise
except Exception as e:
# Handle other types of exceptions that don't have response attribute
raise
def _get_fallback_headers(self, original_headers: dict) -> dict:
"""
Generate fallback authentication headers.
If using Bearer, fallback to PRIVATE-TOKEN and vice versa.
"""
base_headers = {
'User-Agent': USER_AGENT,
"accept": "application/json"
}
# If currently using Bearer, try PRIVATE-TOKEN
if 'Authorization' in original_headers and 'Bearer' in original_headers['Authorization']:
log.debug("Falling back from Bearer to PRIVATE-TOKEN authentication")
return {
**base_headers,
'PRIVATE-TOKEN': f"{self.config.token}"
}
# If currently using PRIVATE-TOKEN, try Bearer
elif 'PRIVATE-TOKEN' in original_headers:
log.debug("Falling back from PRIVATE-TOKEN to Bearer authentication")
return {
**base_headers,
'Authorization': f"Bearer {self.config.token}"
}
# No fallback available
return {}
def check_event_type(self) -> str:
pipeline_source = self.config.pipeline_source.lower()
if pipeline_source in ["web", 'merge_request_event', "push", "api", 'pipeline']:
if not self.config.mr_iid:
return "main"
return "diff"
elif pipeline_source == "issue_comment":
return "comment"
else:
log.error(f"Unknown event type {pipeline_source}")
sys.exit(0)
def post_comment(self, body: str) -> None:
path = f"projects/{self.config.mr_project_id}/merge_requests/{self.config.mr_iid}/notes"
payload = {"body": body}
self._request_with_fallback(
path=path,
payload=payload,
method="POST",
headers=self.config.headers,
base_url=self.config.api_url
)
def update_comment(self, body: str, comment_id: str) -> None:
path = f"projects/{self.config.mr_project_id}/merge_requests/{self.config.mr_iid}/notes/{comment_id}"
payload = {"body": body}
self._request_with_fallback(
path=path,
payload=payload,
method="PUT",
headers=self.config.headers,
base_url=self.config.api_url
)
def get_comments_for_pr(self) -> dict:
log.debug(f"Getting Gitlab comments for Repo {self.config.repository} for PR {self.config.mr_iid}")
path = f"projects/{self.config.mr_project_id}/merge_requests/{self.config.mr_iid}/notes"
response = self._request_with_fallback(
path=path,
headers=self.config.headers,
base_url=self.config.api_url
)
raw_comments = Comments.process_response(response)
comments = {}
if "message" not in raw_comments:
for item in raw_comments:
comment = Comment(**item)
comments[comment.id] = comment
comment.body_list = comment.body.split("\n")
else:
log.error(raw_comments)
return Comments.check_for_socket_comments(comments)
def add_socket_comments(
self,
security_comment: str,
overview_comment: str,
comments: dict,
new_security_comment: bool = True,
new_overview_comment: bool = True
) -> None:
existing_overview_comment = comments.get("overview")
existing_security_comment = comments.get("security")
if new_overview_comment:
log.debug("New Dependency Overview comment")
if existing_overview_comment is not None:
log.debug("Previous version of Dependency Overview, updating")
# Type narrowing: after None check, mypy knows this is Comment
self.update_comment(overview_comment, str(existing_overview_comment.id))
else:
log.debug("No previous version of Dependency Overview, posting")
self.post_comment(overview_comment)
if new_security_comment:
log.debug("New Security Issue Comment")
if existing_security_comment is not None:
log.debug("Previous version of Security Issue comment, updating")
# Type narrowing: after None check, mypy knows this is Comment
self.update_comment(security_comment, str(existing_security_comment.id))
else:
log.debug("No Previous version of Security Issue comment, posting")
self.post_comment(security_comment)
def enable_merge_pipeline_check(self) -> None:
"""Enable 'only_allow_merge_if_pipeline_succeeds' on the MR target project."""
if not self.config.mr_project_id:
return
url = f"{self.config.api_url}/projects/{self.config.mr_project_id}"
try:
resp = requests.put(
url,
json={"only_allow_merge_if_pipeline_succeeds": True},
headers=self.config.headers,
)
if resp.status_code == 401:
fallback = self._get_fallback_headers(self.config.headers)
if fallback:
resp = requests.put(
url,
json={"only_allow_merge_if_pipeline_succeeds": True},
headers=fallback,
)
if resp.status_code >= 400:
log.error(f"GitLab enable merge check API {resp.status_code}: {resp.text}")
else:
log.info("Enabled 'pipelines must succeed' merge check on project")
except Exception as e:
log.error(f"Failed to enable merge pipeline check: {e}")
def set_commit_status(self, state: str, description: str, target_url: str = '') -> None:
"""Post a commit status to GitLab. state should be 'success' or 'failed'.
Uses requests.post with json= directly because CliClient.request sends
data= (form-encoded) which GitLab's commit status endpoint rejects.
"""
if not self.config.mr_project_id:
log.debug("No mr_project_id, skipping commit status")
return
url = f"{self.config.api_url}/projects/{self.config.mr_project_id}/statuses/{self.config.commit_sha}"
payload = {
"state": state,
"context": "socket-security-commit-status",
"description": description,
}
if self.config.mr_source_branch:
payload["ref"] = self.config.mr_source_branch
if target_url:
payload["target_url"] = target_url
try:
log.debug(f"Posting commit status to {url}")
resp = requests.post(url, json=payload, headers=self.config.headers)
if resp.status_code == 401:
fallback = self._get_fallback_headers(self.config.headers)
if fallback:
resp = requests.post(url, json=payload, headers=fallback)
if resp.status_code >= 400:
log.error(f"GitLab commit status API {resp.status_code}: {resp.text}")
resp.raise_for_status()
log.info(f"Commit status set to '{state}' on {self.config.commit_sha[:8]}")
except Exception as e:
log.error(f"Failed to set commit status: {e}")
def remove_comment_alerts(self, comments: dict):
security_alert = comments.get("security")
if security_alert is not None:
# Type narrowing: after None check, mypy knows this is Comment
new_body = Comments.process_security_comment(security_alert, comments)
self.update_comment(new_body, str(security_alert.id))