CheckmarxPythonSDK 1.1.2__tar.gz → 1.1.4__tar.gz

checkmarxpythonsdk-1.1.4/CheckmarxPythonSDK/CxOne/KeycloakAPI/UsersAPI.py

@@ -0,0 +1,325 @@
+import json
+from typing import List
+from ...utilities.compat import CREATED, OK, NO_CONTENT
+from ..httpRequests import get_request, post_request, put_request, delete_request
+from ..utilities import get_url_param, type_check
+from .url import api_url
+from .dto import UserRepresentation, construct_user
+
+
+def get_users(realm, brief_representation=False, email=None, email_verified=None, enabled=None, exact=None, first=None,
+              first_name=None, idp_alias=None, idp_user_id=None, last_name=None, max_result_size=1024, search=None,
+              username=None):
+    """
+    Returns a stream of users, filtered according to query parameters
+
+    Args:
+        realm (str): realm name (not id!)
+        brief_representation (bool): Boolean which defines whether brief representations are returned (default: false)
+        email (str): A String contained in email, or the complete email, if param "exact" is true
+        email_verified (bool): whether the email has been verified
+        enabled (bool): representing if user is enabled or not
+        exact (bool): which defines whether the params "last", "first", "email" and "username" must match exactly
+        first (int): Pagination offset
+        first_name (str): A String contained in firstName, or the complete firstName, if param "exact" is true
+        idp_alias (str): The alias of an Identity Provider linked to the user
+        idp_user_id (str): The userId at an Identity Provider linked to the user
+        last_name (str): A String contained in lastName, or the complete lastName, if param "exact" is true
+        max_result_size (int): Maximum results size (defaults to 100)
+        search (str): A String contained in username, first or last name, or email
+        username (str): A String contained in username, or the complete username, if param "exact" is true
+
+    Returns:
+        list of User
+    """
+    type_check(realm, str)
+    type_check(brief_representation, bool)
+    type_check(email, str)
+    type_check(email_verified, bool)
+    type_check(enabled, bool)
+    type_check(exact, bool)
+    type_check(first, int)
+    type_check(first_name, str)
+    type_check(idp_alias, str)
+    type_check(idp_user_id, str)
+    type_check(last_name, str)
+    type_check(max_result_size, int)
+    type_check(search, str)
+    type_check(username, str)
+
+    relative_url = api_url + "/{realm}/users?".format(realm=realm)
+    relative_url += get_url_param("briefRepresentation", brief_representation)
+
+    relative_url += get_url_param("email", email)
+    relative_url += get_url_param("emailVerified", email_verified)
+    relative_url += get_url_param("enabled", enabled)
+    relative_url += get_url_param("exact", exact)
+    relative_url += get_url_param("first", first)
+    relative_url += get_url_param("firstName", first_name)
+    relative_url += get_url_param("idpAlias", idp_alias)
+    relative_url += get_url_param("idpUserId", idp_user_id)
+    relative_url += get_url_param("lastName", last_name)
+    relative_url += get_url_param("max", max_result_size)
+    relative_url += get_url_param("search", search)
+    relative_url += get_url_param("username", username)
+
+    response = get_request(relative_url=relative_url, is_iam=True)
+    users = response.json()
+    return [construct_user(user) for user in users]
+
+
+def _filter_user_id_by_name(users, username):
+    """
+
+    Args:
+        users (list of User):
+        username (str):
+
+    Returns:
+        str or None
+    """
+    users_by_name = list(filter(lambda r: r.username == username, users))
+    if not users_by_name:
+        return None
+    user = users_by_name[0]
+    user_id = user.id
+    return user_id
+
+
+def get_user_id_by_name(realm, username):
+    """
+
+    Args:
+        realm (str):
+        username (str):
+
+    Returns:
+        str
+    """
+    users = get_users(realm=realm)
+    user_id = _filter_user_id_by_name(users, username)
+    return user_id
+
+
+def get_user_id_list_by_username_list(realm: str, username_list: List[str]):
+    """
+
+    Args:
+        realm (str):
+        username_list (list of str):
+
+    Returns:
+        list of str
+    """
+    users = get_users(realm=realm)
+    return [_filter_user_id_by_name(users, username) for username in username_list]
+
+
+def _filter_user_id_by_email(users, email):
+    """
+
+    Args:
+        users:
+        email:
+
+    Returns:
+
+    """
+    users_by_email = list(filter(lambda r: r.email == email, users))
+    if not users_by_email:
+        return None
+    user = users_by_email[0]
+    user_id = user.id
+    return user_id
+
+
+def get_user_id_by_email(realm, email):
+    """
+
+    Args:
+        realm (str):
+        email (str):
+
+    Returns:
+        str
+    """
+    users = get_users(realm=realm)
+    user_id = _filter_user_id_by_email(users, email)
+    return user_id
+
+
+def get_user_id_list_by_email_list(realm, email_list):
+    users = get_users(realm=realm)
+    return [_filter_user_id_by_email(users, email) for email in email_list]
+
+
+def create_a_new_user(realm, username, email, first_name, last_name, enabled=True, attributes=None, groups=None,
+                      email_verified=False, required_actions=None):
+    """
+    Username must be unique.
+    Args:
+        realm (str): realm name (not id!)
+        username (str):
+        email (str):
+        first_name (str):
+        last_name (str):
+        enabled (bool): user enabled
+        attributes (dict): example: {"other":["ccc for test"]}
+        groups (list of str):
+        email_verified (bool):
+        required_actions (list of str): example: ["UPDATE_PASSWORD"]
+
+    Returns:
+        bool
+    """
+    result = False
+    relative_url = api_url + "/{realm}/users?".format(realm=realm)
+    type_check(username, str)
+    type_check(email, str)
+    type_check(first_name, str)
+    type_check(last_name, str)
+    type_check(enabled, bool)
+    type_check(attributes, dict)
+    type_check(groups, list)
+    type_check(email_verified, bool)
+    type_check(required_actions, list)
+    data = {
+        "enabled": enabled,
+        "attributes": attributes or {},
+        "groups": groups or [],
+        "emailVerified": email_verified,
+        "username": username,
+        "email": email,
+        "firstName": first_name,
+        "lastName": last_name,
+    }
+    if required_actions:
+        data.update({"requiredActions": required_actions or []})
+    data = json.dumps(data)
+    response = post_request(relative_url=relative_url, data=data, is_iam=True)
+    if response.status_code == CREATED:
+        result = True
+    return result
+
+
+def get_number_of_users_by_given_criteria(realm, email=None, email_verified=None, enabled=None, first_name=None,
+                                          last_name=None, q=None, search=None, username=None):
+    """
+        Returns the number of users that match the given criteria.
+    Args:
+        realm (str):  realm name (not id!)
+        email (str): email filter
+        email_verified (str):
+        enabled (str): Boolean representing if user is enabled or not
+        first_name (str): first name filter
+        last_name (str):
+        q (str):
+        search (str): arbitrary search string for all the fields below. Default search behavior is prefix-based
+                (e.g., foo or foo*). Use foo for infix search and "foo" for exact search.
+        username (str): username filter
+
+    Returns:
+        int
+    """
+    relative_url = api_url + f"/{realm}/users/count"
+    relative_url += get_url_param("email", email)
+    relative_url += get_url_param("emailVerified", email_verified)
+    relative_url += get_url_param("enabled", enabled)
+    relative_url += get_url_param("firstName", first_name)
+    relative_url += get_url_param("lastName", last_name)
+    relative_url += get_url_param("q", q)
+    relative_url += get_url_param("search", search)
+    relative_url += get_url_param("username", username)
+    response = get_request(relative_url=relative_url, is_iam=True)
+    result = response.json()
+    return result
+
+
+def delete_user(realm, user_id):
+    """
+
+    Args:
+        realm (str):  realm name (not id!)
+        user_id (str):
+
+    Returns:
+
+    """
+    result = False
+    relative_url = api_url + f"/{realm}/users/{user_id}"
+    type_check(realm, str)
+    type_check(user_id, str)
+    response = delete_request(relative_url=relative_url, is_iam=True)
+    if response.status_code == NO_CONTENT:
+        result = True
+    return result
+
+
+def get_users_profile(realm):
+    """
+
+    Args:
+        realm (str):
+
+    Returns:
+
+    """
+    relative_url = api_url + f"/{realm}/users/profile"
+    response = get_request(relative_url=relative_url, is_iam=True)
+    return response.json()
+
+
+def get_users_profile_metadata(realm):
+    """
+
+    Args:
+        realm:
+
+    Returns:
+
+    """
+    relative_url = api_url + f"/{realm}/users/profile/metadata"
+    response = get_request(relative_url=relative_url, is_iam=True)
+    return response.json()
+
+
+def get_user_by_id(realm, user_id):
+    """
+
+    Args:
+        realm (str):
+        user_id (str):
+
+    Returns:
+
+    """
+    type_check(realm, str)
+    type_check(user_id, str)
+    relative_url = api_url + f"/{realm}/users/{user_id}"
+    response = get_request(relative_url=relative_url, is_iam=True)
+    return response.json()
+
+
+def update_user_by_id(realm, user_id, username, first_name, last_name, email,
+                      email_verified=True, user_enabled=True,
+                      totp=False, required_actions=None, manage_group_members_ship_access=True, view_access=True,
+                      map_roles_access=True, impersonate_access=True, manage_access=True, attributes=None):
+    result = False
+    relative_url = api_url + f"/{realm}/users/{user_id}"
+    data = {
+        "username": username, "firstName": first_name, "lastName": last_name, "email": email,
+        "emailVerified": email_verified, "enabled": user_enabled, "totp": totp,
+        "disableableCredentialTypes": [], "requiredActions": required_actions or [], "notBefore": 0,
+        "access": {
+            "manageGroupMembership": manage_group_members_ship_access, "view": view_access,
+            "mapRoles": map_roles_access, "impersonate": impersonate_access,
+            "manage": manage_access
+        },
+    }
+    if attributes:
+        data.update({"attributes": attributes})
+    data = json.dumps(data)
+    response = put_request(relative_url=relative_url, data=data, is_iam=True)
+    if response.status_code == NO_CONTENT:
+        result = True
+    return result

{checkmarxpythonsdk-1.1.2 → checkmarxpythonsdk-1.1.4}/CheckmarxPythonSDK/CxOne/KeycloakAPI/__init__.py

@@ -1,7 +1,17 @@
 from .RootAPI import get_realms
 from .UsersAPI import (
     get_users,
-    create_a_new_user
+    get_user_id_by_name,
+    get_user_id_list_by_username_list,
+    get_user_id_by_email,
+    get_user_id_list_by_email_list,
+    create_a_new_user,
+    get_number_of_users_by_given_criteria,
+    delete_user,
+    get_users_profile,
+    get_users_profile_metadata,
+    get_user_by_id,
+    update_user_by_id,
 )
 
 from .GroupsAPI import (
@@ -21,4 +31,4 @@ from .GroupsAPI import (
 
 from .RoleMapperAPI import (
     get_role_mappings,
-)
+)

{checkmarxpythonsdk-1.1.2 → checkmarxpythonsdk-1.1.4}/CheckmarxPythonSDK/CxOne/httpRequests.py

@@ -14,8 +14,6 @@ def get_data_from_config():
     cert = config.get("cert")
     token_req_data = {
         "grant_type": "client_credentials",
-        "username": config.get("username"),
-        "password": config.get("password"),
         "client_id": config.get("client_id"),
         "client_secret": config.get("client_secret"),
     }

{checkmarxpythonsdk-1.1.2 → checkmarxpythonsdk-1.1.4}/CheckmarxPythonSDK/CxScaApiSDK/api.py

@@ -1965,12 +1965,55 @@ class Sca(object):
                  "cvss3 { attackComplexity, attackVector, availability, availabilityRequirement, baseScore, "
                  "confidentiality, confidentialityRequirement, exploitCodeMaturity, integrity, integrityRequirement, "
                  "privilegesRequired, remediationLevel, reportConfidence, scope, userInteraction }, "
+                 "vulnerabilityFixResolutionText,"
                  "pendingState, pendingChanges, packageState { type, value }, pendingScore, pendingSeverity,"
                  " isScoreOverridden } }"
                  " }")
         response = self.gql_request(relative_url=self.gql_relative_url, data=query)
         return response
 
+    def get_one_vulnerability(self, scan_id, vulnerability_id, package_id):
+        """
+            This is a GraphQL API
+        Args:
+            scan_id (str):
+            vulnerability_id (str):
+            package_id (str):
+
+        Returns:
+
+        """
+        query = ("query { "
+                 "vulnerability  ("      
+                 f"scanId:  \"{scan_id}\", "
+                 f"vulnerabilityId:  \"{vulnerability_id}\", "
+                 f"packageId:  \"{package_id}\""
+                 ")"
+                 "{ packageState { type, value }, assignedPolicies, violatedPolicies, pendingChanges, pendingState, "
+                 "state, score, pendingScore, pendingSeverity, isScoreOverridden, morEntityProfilesApplied, credit, "
+                 "notes, isIgnored, cve, cwe, description, packageId, severity, type, published, isKevDataExists, "
+                 "isExploitDbDataExists, isVulnerabilityNew, detectionDate, relation, vulnerabilityFixResolutionText, "
+                 "cweInfo { title }, packageInfo { name, packageRepository, version }, isExploitable, exploitablePath "
+                 "{ methodMatch { fullName, line, namespace, shortName, sourceFile }, methodSourceCall { fullName, "
+                 "line, namespace, shortName, sourceFile } }, "
+                 "vulnerablePackagePath { id, isDevelopment, isResolved, "
+                 "name, version, vulnerabilityRiskLevel }, "
+                 "references { comment, type, url }, "
+                 "cvss2 { attackComplexity, attackVector, authentication, availability, availabilityRequirement,"
+                 " baseScore, collateralDamagePotential, confidentiality, confidentialityRequirement,"
+                 " exploitCodeMaturity, integrityImpact, integrityRequirement, remediationLevel, reportConfidence, "
+                 "targetDistribution, severity }, cvss3 { attackComplexity, attackVector, availability,"
+                 " availabilityRequirement, baseScore, confidentiality, confidentialityRequirement, "
+                 "exploitCodeMaturity, integrity, integrityRequirement, privilegesRequired, remediationLevel, "
+                 "reportConfidence, scope, userInteraction, severity }, "
+                 "cvss4 { attackComplexity, attackVector, attackRequirements, privilegesRequired, userInteraction, "
+                 "vulnerableSystemConfidentiality, vulnerableSystemIntegrity, vulnerableSystemAvailability, "
+                 "subsequentSystemConfidentiality, subsequentSystemIntegrity, subsequentSystemAvailability, "
+                 "baseScore, severity }, isEpssDataExists, epssData { cve, date, epss, percentile } }"
+                 " }")
+        response = self.gql_request(relative_url=self.gql_relative_url, data=query)
+        return response
+
     def get_supply_chain_risks_by_scan_id(self, scan_id, take=10, skip=0):
         """
             This is a GraphQL API
@@ -2667,6 +2710,10 @@ def get_vulnerabilities_risks_by_scan_id(scan_id, is_exploitable_path_enabled=Fa
                                                       take=take, skip=skip)
 
 
+def get_one_vulnerability(scan_id, vulnerability_id, package_id):
+    return Sca().get_one_vulnerability(scan_id=scan_id, vulnerability_id=vulnerability_id, package_id=package_id)
+
+
 def get_supply_chain_risks_by_scan_id(scan_id, take=10, skip=0):
     return Sca().get_supply_chain_risks_by_scan_id(scan_id, take=take, skip=skip)
 

checkmarxpythonsdk-1.1.4/CheckmarxPythonSDK/__version__.py

@@ -0,0 +1 @@
+__version__ = '1.1.4'

{checkmarxpythonsdk-1.1.2 → checkmarxpythonsdk-1.1.4}/CheckmarxPythonSDK.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: CheckmarxPythonSDK
-Version: 1.1.2
+Version: 1.1.4
 Summary: Checkmarx Python SDK
 Home-page: https://github.com/checkmarx-ts/checkmarx-python-sdk
 Author: Happy Yang
@@ -28,6 +28,16 @@ Requires-Dist: python-dotenv; extra == "dotenv"
 Provides-Extra: dev
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: coverage; extra == "dev"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 # Checkmarx Python SDK
 

{checkmarxpythonsdk-1.1.2 → checkmarxpythonsdk-1.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: CheckmarxPythonSDK
-Version: 1.1.2
+Version: 1.1.4
 Summary: Checkmarx Python SDK
 Home-page: https://github.com/checkmarx-ts/checkmarx-python-sdk
 Author: Happy Yang
@@ -28,6 +28,16 @@ Requires-Dist: python-dotenv; extra == "dotenv"
 Provides-Extra: dev
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: coverage; extra == "dev"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 # Checkmarx Python SDK
 

checkmarxpythonsdk-1.1.2/CheckmarxPythonSDK/CxOne/KeycloakAPI/UsersAPI.py

@@ -1,86 +0,0 @@
-from ...utilities.compat import CREATED
-from ..httpRequests import get_request, post_request, put_request, delete_request
-from ..utilities import get_url_param, type_check
-from .url import api_url
-from .dto import UserRepresentation, construct_user
-
-
-def get_users(realm, brief_representation=False, email=None, email_verified=None, enabled=None, exact=None, first=None,
-              first_name=None, idp_alias=None, idp_user_id=None, last_name=None, max_result_size=100, search=None,
-              username=None):
-    """
-    Returns a stream of users, filtered according to query parameters
-
-    Args:
-        realm (str): realm name (not id!)
-        brief_representation (bool): Boolean which defines whether brief representations are returned (default: false)
-        email (str): A String contained in email, or the complete email, if param "exact" is true
-        email_verified (bool): whether the email has been verified
-        enabled (bool): representing if user is enabled or not
-        exact (bool): which defines whether the params "last", "first", "email" and "username" must match exactly
-        first (int): Pagination offset
-        first_name (str): A String contained in firstName, or the complete firstName, if param "exact" is true
-        idp_alias (str): The alias of an Identity Provider linked to the user
-        idp_user_id (str): The userId at an Identity Provider linked to the user
-        last_name (str): A String contained in lastName, or the complete lastName, if param "exact" is true
-        max_result_size (int): Maximum results size (defaults to 100)
-        search (str): A String contained in username, first or last name, or email
-        username (str): A String contained in username, or the complete username, if param "exact" is true
-
-    Returns:
-        list of User
-    """
-    type_check(realm, str)
-    type_check(brief_representation, bool)
-    type_check(email, str)
-    type_check(email_verified, bool)
-    type_check(enabled, bool)
-    type_check(exact, bool)
-    type_check(first, int)
-    type_check(first_name, str)
-    type_check(idp_alias, str)
-    type_check(idp_user_id, str)
-    type_check(last_name, str)
-    type_check(max_result_size, int)
-    type_check(search, str)
-    type_check(username, str)
-
-    relative_url = api_url + "/{realm}/users?".format(realm=realm)
-    relative_url += get_url_param("briefRepresentation", brief_representation)
-
-    relative_url += get_url_param("email", email)
-    relative_url += get_url_param("emailVerified", email_verified)
-    relative_url += get_url_param("enabled", enabled)
-    relative_url += get_url_param("exact", exact)
-    relative_url += get_url_param("first", first)
-    relative_url += get_url_param("firstName", first_name)
-    relative_url += get_url_param("idpAlias", idp_alias)
-    relative_url += get_url_param("idpUserId", idp_user_id)
-    relative_url += get_url_param("lastName", last_name)
-    relative_url += get_url_param("max", max_result_size)
-    relative_url += get_url_param("search", search)
-    relative_url += get_url_param("username", username)
-
-    response = get_request(relative_url=relative_url, is_iam=True)
-    users = response.json()
-    return [construct_user(user) for user in users]
-
-
-def create_a_new_user(realm, user_representation):
-    """
-    Username must be unique.
-    Args:
-        realm (str): realm name (not id!)
-        user_representation (UserRepresentation):
-
-    Returns:
-        bool
-    """
-    result = False
-    relative_url = api_url + "/{realm}/users?".format(realm=realm)
-    type_check(user_representation, UserRepresentation)
-    post_data = user_representation.get_post_data()
-    response = post_request(relative_url=relative_url, data=post_data, is_iam=True)
-    if response.status_code == CREATED:
-        result = True
-    return result

checkmarxpythonsdk-1.1.2/CheckmarxPythonSDK/__version__.py

@@ -1 +0,0 @@
-__version__ = '1.1.2'