Bases: object
Abstract client class.
This class can not be used directly, use cabby.create_client() to create client instances.
Discover services advertised by TAXII server.
This method will send discovery request to a service, defined by uri or constructor’s connection parameters.
Parameters: |
|
---|---|
Returns: | list of TAXII services |
Return type: | list of cabby.entities.DetailedServiceInstance (or cabby.entities.InboxDetailedService) |
Raises: |
|
Get services advertised by TAXII server.
This method will try to do automatic discovery by calling discover_services().
Parameters: |
|
---|---|
Returns: | list of service instances |
Return type: | list of cabby.entities.DetailedServiceInstance (or cabby.entities.InboxDetailedService) |
Raises: |
|
Set authentication credentials.
jwt_auth_url is required for JWT based authentication. If it is not specified but username and password are provided, client will configure Basic authentication.
SSL authentication can be combined with JWT and Basic authentication.
Parameters: |
|
---|
Set proxy properties.
Parameters: |
|
---|
Bases: cabby.abstract.AbstractClient
Client implementation for TAXII Specification v1.0
Use cabby.create_client() to create client instances.
Not supported in TAXII 1.0
Raises cabby.exceptions.NotSupportedError: | |
---|---|
Get collections from Feed Management Service.
if uri is not provided, client will try to discover services and find Feed Management Service among them.
Parameters: | uri (str) – URI path to a specific Feed Management service |
---|---|
Returns: | list of collections |
Return type: | list of cabby.entities.Collection |
Raises: |
|
Not supported in TAXII 1.0
Raises cabby.exceptions.NotSupportedError: | |
---|---|
not supported in TAXII 1.0 |
Get subscription status from TAXII Feed Management service.
Sends a subscription request with action STATUS. If no subscription_id is provided, server will return the list of all available subscriptions for feed with a name specified in collection_name.
if uri is not provided, client will try to discover services and find Feed Management Service among them.
Parameters: |
|
---|---|
Returns: | subscription information response |
Return type: | |
Raises: |
|
Poll content from Polling Service.
if uri is not provided, client will try to discover services and find Polling Service among them.
Parameters: |
|
---|---|
Raises: |
|
Push content into Inbox Service.
if uri is not provided, client will try to discover services and find Inbox Service among them.
Content Binding subtypes and Destionation collections are not supported in TAXII Specification v1.0.
Parameters: |
|
---|---|
Raises: |
|
Create a subscription.
Sends a subscription request with action SUBSCRIBE.
if uri is not provided, client will try to discover services and find Collection Management Service among them.
Content Binding subtypes are not supported in TAXII Specification v1.0.
Parameters: |
|
---|---|
Returns: | subscription information response |
Return type: | |
Raises: |
|
Unsubscribe from a subscription.
Sends a subscription request with action UNSUBSCRIBE. Subscription is identified by collection_name and subscription_id.
if uri is not provided, client will try to discover services and find Collection Management Service among them.
Parameters: |
|
---|---|
Returns: | subscription information response |
Return type: | |
Raises: |
|
Bases: cabby.abstract.AbstractClient
Client implementation for TAXII Specification v1.1
Use cabby.create_client() to create client instances.
Poll content from Polling Service as a part of fulfilment process.
if uri is not provided, client will try to discover services and find Polling Service among them.
Parameters: |
|
---|---|
Raises: |
|
Get collections from Collection Management Service.
if uri is not provided, client will try to discover services and find Collection Management Service among them.
Parameters: | uri (str) – URI path to a specific Collection Management service |
---|---|
Returns: | list of collections |
Return type: | list of cabby.entities.Collection |
Raises: |
|
Get content blocks count for a query.
if uri is not provided, client will try to discover services and find Polling Service among them.
If subscription_id provided, arguments content_bindings and inbox_service are ignored.
Parameters: |
|
---|---|
Raises: |
|
Return type: |
Get subscription status from TAXII Collection Management service.
Sends a subscription request with action STATUS. If no subscription_id is provided, server will return the list of all available subscriptions for a collection with a name specified in collection_name.
if uri is not provided, client will try to discover services and find Collection Management Service among them.
Parameters: |
|
---|---|
Returns: | subscription information response |
Return type: | |
Raises: |
|
Pause a subscription.
Sends a subscription request with action PAUSE. Subscription is identified by collection_name and subscription_id.
if uri is not provided, client will try to discover services and find Collection Management Service among them.
Parameters: |
|
---|---|
Returns: | subscription information response |
Return type: | |
Raises: |
|
Poll content from Polling Service.
if uri is not provided, client will try to discover services and find Polling Service among them.
If subscription_id provided, arguments content_bindings and inbox_service are ignored.
Parameters: |
|
---|---|
Raises: |
|
Push content into Inbox Service.
if uri is not provided, client will try to discover services and find Inbox Service among them.
Parameters: |
|
---|---|
Raises: |
|
Resume a subscription.
Sends a subscription request with action RESUME. Subscription is identified by collection_name and subscription_id.
if uri is not provided, client will try to discover services and find Collection Management Service among them.
Parameters: |
|
---|---|
Returns: | subscription information response |
Return type: | |
Raises: |
|
Create a subscription.
Sends a subscription request with action SUBSCRIBE.
if uri is not provided, client will try to discover services and find Collection Management Service among them.
Parameters: |
|
---|---|
Returns: | subscription information response |
Return type: | |
Raises: |
|
Unsubscribe from a subscription.
Sends a subscription request with action UNSUBSCRIBE. Subscription is identified by collection_name and subscription_id.
if uri is not provided, client will try to discover services and find Collection Management Service among them.
Parameters: |
|
---|---|
Returns: | subscription information response |
Return type: | |
Raises: |
|
Bases: cabby.entities.Entity
Collection entity.
Represents TAXII Collection and TAXII Feed objects.
Parameters: |
|
---|
Bases: cabby.entities.Entity
Content Binding entity.
Represents TAXII Content Binding.
Parameters: |
|
---|
Bases: cabby.entities.Entity
Content Block entity.
Represents TAXII Content Block.
Parameters: |
|
---|
Bases: cabby.entities.Entity
Bases: cabby.entities.Entity
Detailed description of a generic TAXII Service instance
Parameters: |
|
---|
Bases: cabby.entities.DetailedServiceInstance
Detailed description of TAXII Inbox Service.
Parameters: |
|
---|
Bases: cabby.entities.ServiceInstance
Inbox Service entity.
Represents TAXII Inbox Service.
Parameters: |
|
---|
Bases: cabby.entities.Entity
Push Method entity.
Represents TAXII Push Method.
Parameters: |
|
---|
Bases: cabby.entities.Entity
Generic TAXII Service entity.
Parameters: |
|
---|
Bases: cabby.entities.Entity
Subscription entity.
Parameters: |
|
---|
Bases: cabby.entities.Entity
Subscription Parameters Entity.
Represents TAXII Subscription Parameters.
Parameters: |
|
---|
Bases: cabby.entities.Entity
Subscription Response entity.
Parameters: |
|
---|
Bases: exceptions.Exception
Bases: exceptions.ValueError
Cabby, python library for interacting with TAXII servers.
Create a client instance (TAXII version specific).
host, discovery_path, port, use_https values can be overridden per request with uri argument passed to a client’s method.
Parameters: |
|
---|---|
Returns: | client instance |
Return type: |