Skip to content

Commit fa1f2c5

Browse files
committed
doc fixes
1 parent 20cc68c commit fa1f2c5

File tree

3 files changed

+27
-19
lines changed

3 files changed

+27
-19
lines changed

docs/changelog.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ CbAPI 1.3.1 - Released August 3, 2017
77
This is a bugfix release with minor changes:
88

99
* Cb Response
10+
1011
* Add ``partition_operations.py`` script to demonstrate the use of the StoragePartition model object.
1112
* Fix errors when accessing the ``.start`` attribute of child processes.
1213
* Fix errors generated by the ``walk_children.py`` example script. The output has been changed as well to indicate
@@ -19,6 +20,7 @@ This is a bugfix release with minor changes:
1920
``create_process`` method will now wait for the target process to complete before returning.
2021

2122
* Cb Defense
23+
2224
* Add ``wait_for_completion`` flag to ``create_process`` Live Response method, and default to ``True``. The
2325
``create_process`` method will now wait for the target process to complete before returning.
2426

@@ -32,9 +34,11 @@ This release introduces the Live Response API for Cb Defense. A sample ``cblr_cl
3234
Other changes:
3335

3436
* Cb Protection
37+
3538
* You can now create new ``FileRule`` and ``Policy`` model objects in cbapi.
3639

3740
* Cb Response
41+
3842
* Added ``watchlist_exporter.py`` and ``watchlist_importer.py`` scripts to the Cb Response examples directory.
3943
These scripts allow you to export Watchlist data in a human- and machine-readable JSON format and then re-import them into another Cb Response server.
4044
* The ``Sensor`` Model Object now uses the non-paginated (v1) API by default. This fixes any issues encountered when
@@ -46,12 +50,14 @@ Other changes:
4650
``Process`` Model Object.
4751
* Retrieve all events for a process when using ``segment`` ID of zero on a Cb Response 6.1 server.
4852
* Behavior of ``Process.children`` attribute has changed:
53+
4954
* Only one entry is present per child (before there were up to two; one for the spawn event, one for the
5055
terminate event)
5156
* The timestamp is derived from the start time of the process, not the timestamp from the spawn event.
5257
the two timestamps will be off by a few microseconds.
5358
* The old behavior is still available by using the ``Process.childprocs`` attribute instead. This incurs a
5459
performance penalty as another API call will have to be made to collect the childproc information.
60+
5561
* ``Binary`` Model Object now returns False for ``.is_signed`` attribute if it is set to ``(Unknown)``.
5662

5763
* Moved the ``six`` Python module into cbapi and removed the external dependency.
@@ -65,6 +71,7 @@ in the Cb Protection 8.0 APIs.
6571
Other changes:
6672

6773
* Cb Response
74+
6875
* New method ``synchronize()`` added to the ``Feed`` Model Object
6976

7077
* Bug fixes and documentation improvements
@@ -81,6 +88,7 @@ This release includes compatibility fixes for Cb Response 6.1. Changes from 1.0.
8188
* Add ``.all_events`` property to the ``Process`` Model Object to expose a list of all events across all segments.
8289
* Add example script to perform auto-banning based on watchlist hits from Cb Event Forwarder S3 output files.
8390
* Add bulk operations to the ``ThreatReport`` and ``Alert`` Query objects:
91+
8492
* You can now call ``.set_ignored()``, ``.assign()``, and ``.change_status()`` on an ``Alert`` Query object to change
8593
the respective fields for every Alert that matches the query.
8694
* You can now call ``.set_ignored()`` on a ``ThreatReport`` Query object to set or clear the ignored flag for every

docs/live-response.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
CbAPI and Live Response
22
=======================
33

4-
Working with the Cb Response Live Response REST API directly can be difficult. Thankfully, just like the rest of Carbon
4+
Working with the Cb Live Response REST API directly can be difficult. Thankfully, just like the rest of Carbon
55
Black's REST APIs, cbapi provides Pythonic APIs to make working with the Live Response API much easier.
66

77
In addition to easy-to-use APIs to call into Live Response, cbapi also provides a "job-based" interface that allows
@@ -34,7 +34,7 @@ As seen in the example above, the ``.lr_session()`` method is context-aware. Cb
3434
concurrent Live Response session slots (by default, only ten). By wrapping the ``.lr_session()``
3535

3636
A full listing of methods in the cbapi Live Response API is available in the documentation for
37-
the :py:mod:`cbapi.response.live_response_api.LiveResponseSession` class.
37+
the :py:mod:`cbapi.live_response_api.CbLRSessionBase` class.
3838

3939
Live Response Errors
4040
--------------------

docs/response-api.rst

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -48,35 +48,35 @@ Models
4848
Live Response
4949
-------------
5050

51-
.. autoclass:: cbapi.response.live_response_api.LiveResponseSession
51+
.. autoclass:: cbapi.live_response_api.CbLRSessionBase
5252

5353
File Operations
5454
^^^^^^^^^^^^^^^
5555

56-
.. automethod:: cbapi.response.live_response_api.LiveResponseSession.get_file
57-
.. automethod:: cbapi.response.live_response_api.LiveResponseSession.delete_file
58-
.. automethod:: cbapi.response.live_response_api.LiveResponseSession.put_file
59-
.. automethod:: cbapi.response.live_response_api.LiveResponseSession.list_directory
60-
.. automethod:: cbapi.response.live_response_api.LiveResponseSession.create_directory
61-
.. automethod:: cbapi.response.live_response_api.LiveResponseSession.walk
56+
.. automethod:: cbapi.live_response_api.CbLRSessionBase.get_file
57+
.. automethod:: cbapi.live_response_api.CbLRSessionBase.delete_file
58+
.. automethod:: cbapi.live_response_api.CbLRSessionBase.put_file
59+
.. automethod:: cbapi.live_response_api.CbLRSessionBase.list_directory
60+
.. automethod:: cbapi.live_response_api.CbLRSessionBase.create_directory
61+
.. automethod:: cbapi.live_response_api.CbLRSessionBase.walk
6262

6363
Registry Operations
6464
^^^^^^^^^^^^^^^^^^^
6565

66-
.. automethod:: cbapi.response.live_response_api.LiveResponseSession.get_registry_value
67-
.. automethod:: cbapi.response.live_response_api.LiveResponseSession.set_registry_value
68-
.. automethod:: cbapi.response.live_response_api.LiveResponseSession.delete_registry_value
69-
.. automethod:: cbapi.response.live_response_api.LiveResponseSession.create_registry_key
70-
.. automethod:: cbapi.response.live_response_api.LiveResponseSession.delete_registry_key
71-
.. automethod:: cbapi.response.live_response_api.LiveResponseSession.list_registry_keys_and_values
72-
.. automethod:: cbapi.response.live_response_api.LiveResponseSession.list_registry_keys
66+
.. automethod:: cbapi.live_response_api.CbLRSessionBase.get_registry_value
67+
.. automethod:: cbapi.live_response_api.CbLRSessionBase.set_registry_value
68+
.. automethod:: cbapi.live_response_api.CbLRSessionBase.delete_registry_value
69+
.. automethod:: cbapi.live_response_api.CbLRSessionBase.create_registry_key
70+
.. automethod:: cbapi.live_response_api.CbLRSessionBase.delete_registry_key
71+
.. automethod:: cbapi.live_response_api.CbLRSessionBase.list_registry_keys_and_values
72+
.. automethod:: cbapi.live_response_api.CbLRSessionBase.list_registry_keys
7373

7474
Process Operations
7575
^^^^^^^^^^^^^^^^^^
7676

77-
.. automethod:: cbapi.response.live_response_api.LiveResponseSession.kill_process
78-
.. automethod:: cbapi.response.live_response_api.LiveResponseSession.create_process
79-
.. automethod:: cbapi.response.live_response_api.LiveResponseSession.list_processes
77+
.. automethod:: cbapi.live_response_api.CbLRSessionBase.kill_process
78+
.. automethod:: cbapi.live_response_api.CbLRSessionBase.create_process
79+
.. automethod:: cbapi.live_response_api.CbLRSessionBase.list_processes
8080

8181

8282

0 commit comments

Comments
 (0)