Merge pull request #518 from carbonblack/release-1.5.3

CBAPI-5321: Release 1.5.3 Merge to Master
carbonblack · Jun 27, 2024 · be15613 · be15613
2 parents 9d83843 + 3e06527
commit be15613
Show file tree

Hide file tree

Showing 325 changed files with 2,278 additions and 1,874 deletions.
diff --git a/CODE-OF-CONDUCT.md b/CODE-OF-CONDUCT.md
@@ -55,11 +55,11 @@ further defined and clarified by project maintainers.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at oss-coc@vmware.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
+reported by contacting compliance.officer@broadcom.com. All complaints will be
+reviewed and investigated and will result in a response that is deemed necessary
+and appropriate to the circumstances. The project team is obligated to maintain
+confidentiality with regard to the reporter of an incident.  Further details
+of specific enforcement policies may be posted separately.
 
 Project maintainers who do not follow or enforce the Code of Conduct in good
 faith may face temporary or permanent repercussions as determined by other

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,7 +1,7 @@
 # Contributing
 
 We rely on pull requests to keep this project maintained. By participating in this project, you
-agree to abide by the VMware [code of conduct](CODE-OF-CONDUCT.md).
+agree to abide by the project [code of conduct](CODE-OF-CONDUCT.md).
 
 ## Setup 
 

diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020-2023 VMware Inc.
+Copyright (c) 2020-2024 Broadcom Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/README.md b/README.md
@@ -1,8 +1,8 @@
-# VMware Carbon Black Cloud Python SDK
+# Carbon Black Cloud Python SDK
 
-**Latest Version:** 1.5.2
+**Latest Version:** 1.5.3
 <br>
-**Release Date:** May 1, 2024
+**Release Date:** June 27, 2024
 
 [![Coverage Status](https://coveralls.io/repos/github/carbonblack/carbon-black-cloud-sdk-python/badge.svg?t=Id6Baf)](https://coveralls.io/github/carbonblack/carbon-black-cloud-sdk-python)
 [![Codeship Status for carbonblack/carbon-black-cloud-sdk-python](https://app.codeship.com/projects/9e55a370-a772-0138-aae4-129773225755/status?branch=develop)](https://app.codeship.com/projects/402767)

diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-1.5.2
+1.5.3
diff --git a/bin/cbc-sdk-help.py b/bin/cbc-sdk-help.py
@@ -1,7 +1,7 @@
 #!/usr/bin/env python3
 
 # *******************************************************
-# Copyright (c) VMware, Inc. 2020-2023. All Rights Reserved.
+# Copyright (c) Broadcom, Inc. 2020-2024. All Rights Reserved. Carbon Black.
 # SPDX-License-Identifier: MIT
 # *******************************************************
 # *

diff --git a/bin/set-macos-keychain.py b/bin/set-macos-keychain.py
@@ -1,7 +1,7 @@
 #!/usr/bin/env python3
 
 # *******************************************************
-# Copyright (c) VMware, Inc. 2020-2023. All Rights Reserved.
+# Copyright (c) Broadcom, Inc. 2020-2024. All Rights Reserved. Carbon Black.
 # SPDX-License-Identifier: MIT
 # *******************************************************
 # *

diff --git a/bin/set-windows-registry.py b/bin/set-windows-registry.py
@@ -1,7 +1,7 @@
 #!/usr/bin/env python3
 
 # *******************************************************
-# Copyright (c) VMware, Inc. 2020-2023. All Rights Reserved.
+# Copyright (c) Broadcom, Inc. 2020-2024. All Rights Reserved. Carbon Black.
 # SPDX-License-Identifier: MIT
 # *******************************************************
 # *

diff --git a/docs/alerts-migration.rst b/docs/alerts-migration.rst
@@ -1,3 +1,15 @@
+..
+    # *******************************************************
+    # Copyright (c) Broadcom, Inc. 2020-2024. All Rights Reserved. Carbon Black.
+    # SPDX-License-Identifier: MIT
+    # *******************************************************
+    # *
+    # * DISCLAIMER. THIS PROGRAM IS PROVIDED TO YOU "AS IS" WITHOUT
+    # * WARRANTIES OR CONDITIONS OF ANY KIND, WHETHER ORAL OR WRITTEN,
+    # * EXPRESS OR IMPLIED. THE AUTHOR SPECIFICALLY DISCLAIMS ANY IMPLIED
+    # * WARRANTIES OR CONDITIONS OF MERCHANTABILITY, SATISFACTORY QUALITY,
+    # * NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE.
+
 .. _alert-migration-guide:
 
 Alert Migration

diff --git a/docs/alerts.rst b/docs/alerts.rst
@@ -1,3 +1,15 @@
+..
+    # *******************************************************
+    # Copyright (c) Broadcom, Inc. 2020-2024. All Rights Reserved. Carbon Black.
+    # SPDX-License-Identifier: MIT
+    # *******************************************************
+    # *
+    # * DISCLAIMER. THIS PROGRAM IS PROVIDED TO YOU "AS IS" WITHOUT
+    # * WARRANTIES OR CONDITIONS OF ANY KIND, WHETHER ORAL OR WRITTEN,
+    # * EXPRESS OR IMPLIED. THE AUTHOR SPECIFICALLY DISCLAIMS ANY IMPLIED
+    # * WARRANTIES OR CONDITIONS OF MERCHANTABILITY, SATISFACTORY QUALITY,
+    # * NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE.
+
 Alerts
 ======
 
@@ -119,6 +131,29 @@ It is equivalent to:
     More information about the ``solrq`` can be found in
     their `documentation <https://solrq.readthedocs.io/en/latest/index.html>`_.
 
+Export Alerts in CSV format
+---------------------------
+
+Up to 25,000 alerts can be exported in a csv file.
+
+This is an asynchronous process in Carbon Black Cloud and to use the APIs directly, three calls are required;
+start the job, check status until it completes, then download the results.  The SDK wraps these calls and simplifies
+the code needed.
+
+Modify the following example with criteria to meet your needs.
+
+.. code-block:: python
+
+    >>> from cbc_sdk import CBCloudAPI
+    >>> from cbc_sdk.platform import Alert
+    >>> api = CBCloudAPI(profile="YOUR_PROFILE_HERE")
+    >>> alert_query = api.select(Alert).add_criteria("device_os", "WINDOWS").set_minimum_severity(3)\
+    ... .set_time_range(range="-10d")
+    >>> job = alert_query.export()
+    >>> job.await_completion().result()
+    >>> csv_report = job.get_output_as_string()
+    >>> print(csv_report)
+
 Retrieving Alerts for Multiple Organizations
 --------------------------------------------
 

diff --git a/docs/asset-groups.rst b/docs/asset-groups.rst
@@ -1,3 +1,15 @@
+..
+    # *******************************************************
+    # Copyright (c) Broadcom, Inc. 2020-2024. All Rights Reserved. Carbon Black.
+    # SPDX-License-Identifier: MIT
+    # *******************************************************
+    # *
+    # * DISCLAIMER. THIS PROGRAM IS PROVIDED TO YOU "AS IS" WITHOUT
+    # * WARRANTIES OR CONDITIONS OF ANY KIND, WHETHER ORAL OR WRITTEN,
+    # * EXPRESS OR IMPLIED. THE AUTHOR SPECIFICALLY DISCLAIMS ANY IMPLIED
+    # * WARRANTIES OR CONDITIONS OF MERCHANTABILITY, SATISFACTORY QUALITY,
+    # * NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE.
+
 Asset Groups
 ============
 

diff --git a/docs/audit-log.rst b/docs/audit-log.rst
@@ -1,3 +1,15 @@
+..
+    # *******************************************************
+    # Copyright (c) Broadcom, Inc. 2020-2024. All Rights Reserved. Carbon Black.
+    # SPDX-License-Identifier: MIT
+    # *******************************************************
+    # *
+    # * DISCLAIMER. THIS PROGRAM IS PROVIDED TO YOU "AS IS" WITHOUT
+    # * WARRANTIES OR CONDITIONS OF ANY KIND, WHETHER ORAL OR WRITTEN,
+    # * EXPRESS OR IMPLIED. THE AUTHOR SPECIFICALLY DISCLAIMS ANY IMPLIED
+    # * WARRANTIES OR CONDITIONS OF MERCHANTABILITY, SATISFACTORY QUALITY,
+    # * NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE.
+
 Audit Log Events
 ================
 

diff --git a/docs/authentication.rst b/docs/authentication.rst
@@ -1,3 +1,15 @@
+..
+    # *******************************************************
+    # Copyright (c) Broadcom, Inc. 2020-2024. All Rights Reserved. Carbon Black.
+    # SPDX-License-Identifier: MIT
+    # *******************************************************
+    # *
+    # * DISCLAIMER. THIS PROGRAM IS PROVIDED TO YOU "AS IS" WITHOUT
+    # * WARRANTIES OR CONDITIONS OF ANY KIND, WHETHER ORAL OR WRITTEN,
+    # * EXPRESS OR IMPLIED. THE AUTHOR SPECIFICALLY DISCLAIMS ANY IMPLIED
+    # * WARRANTIES OR CONDITIONS OF MERCHANTABILITY, SATISFACTORY QUALITY,
+    # * NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE.
+
 .. _authentication:
 
 Authentication

diff --git a/docs/cbc_sdk.audit_remediation.rst b/docs/cbc_sdk.audit_remediation.rst
@@ -1,3 +1,15 @@
+..
+    # *******************************************************
+    # Copyright (c) Broadcom, Inc. 2020-2024. All Rights Reserved. Carbon Black.
+    # SPDX-License-Identifier: MIT
+    # *******************************************************
+    # *
+    # * DISCLAIMER. THIS PROGRAM IS PROVIDED TO YOU "AS IS" WITHOUT
+    # * WARRANTIES OR CONDITIONS OF ANY KIND, WHETHER ORAL OR WRITTEN,
+    # * EXPRESS OR IMPLIED. THE AUTHOR SPECIFICALLY DISCLAIMS ANY IMPLIED
+    # * WARRANTIES OR CONDITIONS OF MERCHANTABILITY, SATISFACTORY QUALITY,
+    # * NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE.
+
 Audit and Remediation Package
 *****************************
 

diff --git a/docs/cbc_sdk.cache.rst b/docs/cbc_sdk.cache.rst
@@ -1,3 +1,15 @@
+..
+    # *******************************************************
+    # Copyright (c) Broadcom, Inc. 2020-2024. All Rights Reserved. Carbon Black.
+    # SPDX-License-Identifier: MIT
+    # *******************************************************
+    # *
+    # * DISCLAIMER. THIS PROGRAM IS PROVIDED TO YOU "AS IS" WITHOUT
+    # * WARRANTIES OR CONDITIONS OF ANY KIND, WHETHER ORAL OR WRITTEN,
+    # * EXPRESS OR IMPLIED. THE AUTHOR SPECIFICALLY DISCLAIMS ANY IMPLIED
+    # * WARRANTIES OR CONDITIONS OF MERCHANTABILITY, SATISFACTORY QUALITY,
+    # * NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE.
+
 Cache Package
 *************
 

diff --git a/docs/cbc_sdk.cbcloudapi.rst b/docs/cbc_sdk.cbcloudapi.rst
@@ -1,3 +1,15 @@
+..
+    # *******************************************************
+    # Copyright (c) Broadcom, Inc. 2020-2024. All Rights Reserved. Carbon Black.
+    # SPDX-License-Identifier: MIT
+    # *******************************************************
+    # *
+    # * DISCLAIMER. THIS PROGRAM IS PROVIDED TO YOU "AS IS" WITHOUT
+    # * WARRANTIES OR CONDITIONS OF ANY KIND, WHETHER ORAL OR WRITTEN,
+    # * EXPRESS OR IMPLIED. THE AUTHOR SPECIFICALLY DISCLAIMS ANY IMPLIED
+    # * WARRANTIES OR CONDITIONS OF MERCHANTABILITY, SATISFACTORY QUALITY,
+    # * NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE.
+
 The CBCloudAPI Object
 *********************
 

diff --git a/docs/cbc_sdk.credential_providers.rst b/docs/cbc_sdk.credential_providers.rst
@@ -1,3 +1,15 @@
+..
+    # *******************************************************
+    # Copyright (c) Broadcom, Inc. 2020-2024. All Rights Reserved. Carbon Black.
+    # SPDX-License-Identifier: MIT
+    # *******************************************************
+    # *
+    # * DISCLAIMER. THIS PROGRAM IS PROVIDED TO YOU "AS IS" WITHOUT
+    # * WARRANTIES OR CONDITIONS OF ANY KIND, WHETHER ORAL OR WRITTEN,
+    # * EXPRESS OR IMPLIED. THE AUTHOR SPECIFICALLY DISCLAIMS ANY IMPLIED
+    # * WARRANTIES OR CONDITIONS OF MERCHANTABILITY, SATISFACTORY QUALITY,
+    # * NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE.
+
 .. _cbc_sdk.credential_providers:
 
 Credential Providers Package

diff --git a/docs/cbc_sdk.endpoint_standard.rst b/docs/cbc_sdk.endpoint_standard.rst
@@ -1,3 +1,15 @@
+..
+    # *******************************************************
+    # Copyright (c) Broadcom, Inc. 2020-2024. All Rights Reserved. Carbon Black.
+    # SPDX-License-Identifier: MIT
+    # *******************************************************
+    # *
+    # * DISCLAIMER. THIS PROGRAM IS PROVIDED TO YOU "AS IS" WITHOUT
+    # * WARRANTIES OR CONDITIONS OF ANY KIND, WHETHER ORAL OR WRITTEN,
+    # * EXPRESS OR IMPLIED. THE AUTHOR SPECIFICALLY DISCLAIMS ANY IMPLIED
+    # * WARRANTIES OR CONDITIONS OF MERCHANTABILITY, SATISFACTORY QUALITY,
+    # * NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE.
+
 Endpoint Standard Package
 *************************
 

diff --git a/docs/cbc_sdk.enterprise_edr.rst b/docs/cbc_sdk.enterprise_edr.rst
@@ -1,3 +1,15 @@
+..
+    # *******************************************************
+    # Copyright (c) Broadcom, Inc. 2020-2024. All Rights Reserved. Carbon Black.
+    # SPDX-License-Identifier: MIT
+    # *******************************************************
+    # *
+    # * DISCLAIMER. THIS PROGRAM IS PROVIDED TO YOU "AS IS" WITHOUT
+    # * WARRANTIES OR CONDITIONS OF ANY KIND, WHETHER ORAL OR WRITTEN,
+    # * EXPRESS OR IMPLIED. THE AUTHOR SPECIFICALLY DISCLAIMS ANY IMPLIED
+    # * WARRANTIES OR CONDITIONS OF MERCHANTABILITY, SATISFACTORY QUALITY,
+    # * NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE.
+
 Enterprise EDR Package
 **********************
 

diff --git a/docs/cbc_sdk.platform.rst b/docs/cbc_sdk.platform.rst
@@ -1,3 +1,15 @@
+..
+    # *******************************************************
+    # Copyright (c) Broadcom, Inc. 2020-2024. All Rights Reserved. Carbon Black.
+    # SPDX-License-Identifier: MIT
+    # *******************************************************
+    # *
+    # * DISCLAIMER. THIS PROGRAM IS PROVIDED TO YOU "AS IS" WITHOUT
+    # * WARRANTIES OR CONDITIONS OF ANY KIND, WHETHER ORAL OR WRITTEN,
+    # * EXPRESS OR IMPLIED. THE AUTHOR SPECIFICALLY DISCLAIMS ANY IMPLIED
+    # * WARRANTIES OR CONDITIONS OF MERCHANTABILITY, SATISFACTORY QUALITY,
+    # * NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE.
+
 Platform Package
 ****************
 

diff --git a/docs/cbc_sdk.rst b/docs/cbc_sdk.rst
@@ -1,3 +1,15 @@
+..
+    # *******************************************************
+    # Copyright (c) Broadcom, Inc. 2020-2024. All Rights Reserved. Carbon Black.
+    # SPDX-License-Identifier: MIT
+    # *******************************************************
+    # *
+    # * DISCLAIMER. THIS PROGRAM IS PROVIDED TO YOU "AS IS" WITHOUT
+    # * WARRANTIES OR CONDITIONS OF ANY KIND, WHETHER ORAL OR WRITTEN,
+    # * EXPRESS OR IMPLIED. THE AUTHOR SPECIFICALLY DISCLAIMS ANY IMPLIED
+    # * WARRANTIES OR CONDITIONS OF MERCHANTABILITY, SATISFACTORY QUALITY,
+    # * NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE.
+
 CBC SDK Package
 ***************
 

diff --git a/docs/cbc_sdk.workload.rst b/docs/cbc_sdk.workload.rst
@@ -1,3 +1,15 @@
+..
+    # *******************************************************
+    # Copyright (c) Broadcom, Inc. 2020-2024. All Rights Reserved. Carbon Black.
+    # SPDX-License-Identifier: MIT
+    # *******************************************************
+    # *
+    # * DISCLAIMER. THIS PROGRAM IS PROVIDED TO YOU "AS IS" WITHOUT
+    # * WARRANTIES OR CONDITIONS OF ANY KIND, WHETHER ORAL OR WRITTEN,
+    # * EXPRESS OR IMPLIED. THE AUTHOR SPECIFICALLY DISCLAIMS ANY IMPLIED
+    # * WARRANTIES OR CONDITIONS OF MERCHANTABILITY, SATISFACTORY QUALITY,
+    # * NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE.
+
 Workload Package
 *****************
 

diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -1,5 +1,31 @@
+..
+    # *******************************************************
+    # Copyright (c) Broadcom, Inc. 2020-2024. All Rights Reserved. Carbon Black.
+    # SPDX-License-Identifier: MIT
+    # *******************************************************
+    # *
+    # * DISCLAIMER. THIS PROGRAM IS PROVIDED TO YOU "AS IS" WITHOUT
+    # * WARRANTIES OR CONDITIONS OF ANY KIND, WHETHER ORAL OR WRITTEN,
+    # * EXPRESS OR IMPLIED. THE AUTHOR SPECIFICALLY DISCLAIMS ANY IMPLIED
+    # * WARRANTIES OR CONDITIONS OF MERCHANTABILITY, SATISFACTORY QUALITY,
+    # * NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE.
+
 Changelog
-================================
+=========
+
+CBC SDK 1.5.3 - Released June 27, 2024
+--------------------------------------
+
+New Features:
+
+* Export Alerts in CSV format (``Alert.export()``).
+
+Documentation:
+
+* Updated code copyright dates and noted the ownership by Broadcom.
+* Removed the Threat Intelligence example; it's been superseded by the
+  `Carbon Black Cloud Threat Intelligence Connector <https://github.com/carbonblack/carbon-black-cloud-threat-intelligence-connector>`_.
+
 CBC SDK 1.5.2 - Released May 1, 2024
 ------------------------------------
 

diff --git a/docs/compliance.rst b/docs/compliance.rst
@@ -1,3 +1,15 @@
+..
+    # *******************************************************
+    # Copyright (c) Broadcom, Inc. 2020-2024. All Rights Reserved. Carbon Black.
+    # SPDX-License-Identifier: MIT
+    # *******************************************************
+    # *
+    # * DISCLAIMER. THIS PROGRAM IS PROVIDED TO YOU "AS IS" WITHOUT
+    # * WARRANTIES OR CONDITIONS OF ANY KIND, WHETHER ORAL OR WRITTEN,
+    # * EXPRESS OR IMPLIED. THE AUTHOR SPECIFICALLY DISCLAIMS ANY IMPLIED
+    # * WARRANTIES OR CONDITIONS OF MERCHANTABILITY, SATISFACTORY QUALITY,
+    # * NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE.
+
 Compliance Benchmarks
 ======
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -19,11 +19,11 @@
 # -- Project information -----------------------------------------------------
 
 project = 'Carbon Black Cloud Python SDK'
-copyright = '2020-2024 VMware Carbon Black'
+copyright = '2020-2024 Broadcom Inc. - Carbon Black'
 author = 'Developer Relations'
 
 # The full version, including alpha/beta/rc tags
-release = '1.5.2'
+release = '1.5.3'
 
 
 # -- General configuration ---------------------------------------------------