feat(public_api): include validity in scan output

Author: jguerreiro

pygitguardian/models.py

@@ -196,6 +196,7 @@ def __repr__(self) -> str:
 class PolicyBreakSchema(BaseSchema):
  break_type = fields.String(data_key="type", required=True)
  policy = fields.String(required=True)
+ validity = fields.String(required=False, load_default=None, dump_default=None)
  matches = fields.List(fields.Nested(MatchSchema), required=True)
 
  @post_load
@@ -214,11 +215,17 @@ class PolicyBreak(Base):
  SCHEMA = PolicyBreakSchema()
 
  def __init__(
- self, break_type: str, policy: str, matches: List[Match], **kwargs: Any
+ self,
+ break_type: str,
+ policy: str,
+ validity: Optional[str],
+ matches: List[Match],
+ **kwargs: Any,
  ) -> None:
  super().__init__()
  self.break_type = break_type
  self.policy = policy
+ self.validity = validity
  self.matches = matches
 
  @property

tests/cassettes/secret_validity.yaml

@@ -0,0 +1,102 @@
+interactions:
+ - request:
+ body:
+ '{"document": "\n import urllib.request\n url = ''http://jen_barber:correcthorsebatterystaple@cake.gitguardian.com/isreal.json''\n response
+ = urllib.request.urlopen(url)\n consume(response.read())\"\n"}'
+ headers:
+ Accept:
+ - '*/*'
+ Accept-Encoding:
+ - gzip, deflate
+ Connection:
+ - keep-alive
+ Content-Length:
+ - '211'
+ Content-Type:
+ - application/json
+ User-Agent:
+ - pygitguardian/1.1.0 (Linux;py3.8.3)
+ method: POST
+ uri: https://api.gitguardian.com/v1/scan
+ response:
+ body:
+ string:
+ '{"policy_break_count":1,"policies":["Secrets detection","File extensions","Filenames"],"policy_breaks":[{"type":"Basic
+ Auth String","policy":"Secrets detection","validity":"valid","matches":[{"type":"username","match":"jen_barber","index_start":40,"index_end":49,"line_start":2,"line_end":2},{"type":"password","match":"correcthorsebatterystaple","index_start":51,"index_end":75,"line_start":2,"line_end":2},{"type":"host","match":"cake.gitguardian.com","index_start":77,"index_end":96,"line_start":2,"line_end":2}]}]}'
+ headers:
+ Allow:
+ - OPTIONS, POST
+ Connection:
+ - keep-alive
+ Content-Length:
+ - '499'
+ Content-Type:
+ - application/json
+ Date:
+ - Fri, 19 Jun 2020 13:32:51 GMT
+ Server:
+ - nginx
+ Vary:
+ - Cookie
+ X-Content-Type-Options:
+ - nosniff
+ X-Frame-Options:
+ - DENY
+ X-App-Version:
+ - 1.26.0-rc.4
+ X-Secrets-Engine-Version:
+ - 2.43.0
+ status:
+ code: 200
+ message: OK
+ - request:
+ body:
+ '{"document": "\n import urllib.request\n url = ''http://jen_barber:correcthorsebatterystaple@cake.gitguardian.com/isreal.json''\n response
+ = urllib.request.urlopen(url)\n consume(response.read())\"\n"}'
+ headers:
+ Accept:
+ - '*/*'
+ Accept-Encoding:
+ - gzip, deflate
+ Connection:
+ - keep-alive
+ Content-Length:
+ - '211'
+ Content-Type:
+ - application/json
+ User-Agent:
+ - pygitguardian/1.1.0 (Linux;py3.8.3)
+ method: POST
+ uri: https://api.gitguardian.com/v1/scan
+ response:
+ body:
+ string:
+ '{"policy_break_count":1,"policies":["Secrets detection","File extensions","Filenames"],"policy_breaks":[{"type":"Basic
+ Auth String","policy":"Secrets detection","matches":[{"type":"username","match":"jen_barber","index_start":40,"index_end":49,"line_start":2,"line_end":2},{"type":"password","match":"correcthorsebatterystaple","index_start":51,"index_end":75,"line_start":2,"line_end":2},{"type":"host","match":"cake.gitguardian.com","index_start":77,"index_end":96,"line_start":2,"line_end":2}]}]}'
+ headers:
+ Allow:
+ - OPTIONS, POST
+ Connection:
+ - keep-alive
+ Content-Length:
+ - '499'
+ Content-Type:
+ - application/json
+ Date:
+ - Fri, 19 Jun 2020 14:58:41 GMT
+ Server:
+ - nginx
+ Vary:
+ - Cookie
+ X-Content-Type-Options:
+ - nosniff
+ X-Frame-Options:
+ - DENY
+ X-App-Version:
+ - 1.26.0-rc.4
+ X-Secrets-Engine-Version:
+ - 2.43.0
+ status:
+ code: 200
+ message: OK
+version: 1

tests/test_client.py

@@ -418,7 +418,17 @@ def test_content_not_ok():
  True,
  id="filename_secret",
  ),
- pytest.param("secret", {"document": DOCUMENT}, 1, True, True, id="secret"),
+ pytest.param(
+ "secret", {"document": DOCUMENT}, 1, True, True, id="secret (deprecated)"
+ ),
+ pytest.param(
+ "secret_validity",
+ {"document": DOCUMENT},
+ 1,
+ True,
+ True,
+ id="secret with validity",
+ ),
  pytest.param(
  "filename",
  {"filename": FILENAME, "document": "normal"},