1:mod:`libtaxii.constants` Module 2================================ 3 4.. module:: libtaxii.constants 5 6Constants 7--------- 8 9Version IDs 10*********** 11 12The following constants can be used as TAXII Version IDs 13 14.. autodata:: VID_TAXII_SERVICES_10 15.. autodata:: VID_TAXII_SERVICES_11 16.. autodata:: VID_TAXII_XML_10 17.. autodata:: VID_TAXII_XML_11 18.. autodata:: VID_TAXII_HTTP_10 19.. autodata:: VID_TAXII_HTTPS_10 20 21The following are third-party Version IDs included in libtaxii for convenience. 22 23.. autodata:: VID_CERT_EU_JSON_10 24 25 26Content Binding IDs 27******************* 28 29The following constants should be used as the Content Binding ID for STIX XML. 30 31.. autodata:: CB_STIX_XML_10 32.. autodata:: CB_STIX_XML_101 33.. autodata:: CB_STIX_XML_11 34.. autodata:: CB_STIX_XML_111 35.. autodata:: CB_STIX_XML_12 36 37These other Content Binding IDs are included for convenience as well. 38 39.. autodata:: CB_CAP_11 40.. autodata:: CB_XENC_122002 41.. autodata:: CB_SMIME 42 43Namespace Map 44************* 45This constant contains commonly namespaces and aliases in TAXII. 46 47.. autodata:: NS_MAP 48 49Message Types 50************* 51 52.. autodata:: MSG_STATUS_MESSAGE 53.. autodata:: MSG_DISCOVERY_REQUEST 54.. autodata:: MSG_DISCOVERY_RESPONSE 55.. autodata:: MSG_FEED_INFORMATION_REQUEST 56.. autodata:: MSG_FEED_INFORMATION_RESPONSE 57.. autodata:: MSG_MANAGE_FEED_SUBSCRIPTION_REQUEST 58.. autodata:: MSG_MANAGE_FEED_SUBSCRIPTION_RESPONSE 59.. autodata:: MSG_POLL_REQUEST 60.. autodata:: MSG_POLL_RESPONSE 61.. autodata:: MSG_INBOX_MESSAGE 62 63.. autodata:: MSG_TYPES_10 64 65.. autodata:: MSG_POLL_FULFILLMENT_REQUEST 66.. autodata:: MSG_COLLECTION_INFORMATION_REQUEST 67.. autodata:: MSG_COLLECTION_INFORMATION_RESPONSE 68.. autodata:: MSG_MANAGE_COLLECTION_SUBSCRIPTION_REQUEST 69.. autodata:: MSG_MANAGE_COLLECTION_SUBSCRIPTION_RESPONSE 70 71.. autodata:: MSG_TYPES_11 72 73 74Status Types 75************ 76 77These constants are used in :py:class:`StatusMessage`. 78 79.. autodata:: ST_BAD_MESSAGE 80.. autodata:: ST_DENIED 81.. autodata:: ST_FAILURE 82.. autodata:: ST_NOT_FOUND 83.. autodata:: ST_POLLING_UNSUPPORTED 84.. autodata:: ST_RETRY 85.. autodata:: ST_SUCCESS 86.. autodata:: ST_UNAUTHORIZED 87.. autodata:: ST_UNSUPPORTED_MESSAGE_BINDING 88.. autodata:: ST_UNSUPPORTED_CONTENT_BINDING 89.. autodata:: ST_UNSUPPORTED_PROTOCOL 90 91.. autodata:: ST_TYPES_10 92 93.. autodata:: ST_ASYNCHRONOUS_POLL_ERROR 94.. autodata:: ST_DESTINATION_COLLECTION_ERROR 95.. autodata:: ST_INVALID_RESPONSE_PART 96.. autodata:: ST_NETWORK_ERROR 97.. autodata:: ST_PENDING 98.. autodata:: ST_UNSUPPORTED_QUERY 99 100.. autodata:: ST_TYPES_11 101 102 103Subscription Actions 104******************** 105 106These constants are used in :py:class:`ManageFeedSubscriptionRequest` 107 108.. autodata:: ACT_SUBSCRIBE 109.. autodata:: ACT_UNSUBSCRIBE 110.. autodata:: ACT_STATUS 111 112.. autodata:: ACT_TYPES_10 113 114.. autodata:: ACT_PAUSE 115.. autodata:: ACT_RESUME 116 117.. autodata:: ACT_TYPES_11 118 119 120Service Types 121**************** 122 123These constants are used to indicate the type of service. 124 125.. autodata:: SVC_INBOX 126.. autodata:: SVC_POLL 127.. autodata:: SVC_FEED_MANAGEMENT 128.. autodata:: SVC_DISCOVERY 129 130.. autodata:: SVC_TYPES_10 131 132.. autodata:: SVC_COLLECTION_MANAGEMENT 133 134.. autodata:: SVC_TYPES_11 135 136Subscription Statuses 137********************* 138 139These constants are used in :py:class:`ManageCollectionSubscriptionResponse` 140 141.. autodata:: SS_ACTIVE 142.. autodata:: SS_PAUSED 143.. autodata:: SS_UNSUBSCRIBED 144 145.. autodata:: SS_TYPES_11 146 147 148Response Types 149************** 150 151These constants are used to indicate the type of response returned. 152 153.. autodata:: RT_FULL 154.. autodata:: RT_COUNT_ONLY 155 156.. autodata:: RT_TYPES_11 157 158 159Collection Types 160**************** 161 162These constants are used to indicate the type of collection. 163 164.. autodata:: CT_DATA_FEED 165.. autodata:: CT_DATA_SET 166 167.. autodata:: CT_TYPES_11 168 169Status Details 170************** 171 172These constants are used in :py:class:`StatusMessage`. 173 174.. autodata:: SD_ACCEPTABLE_DESTINATION 175.. autodata:: SD_MAX_PART_NUMBER 176.. autodata:: SD_ITEM 177.. autodata:: SD_ESTIMATED_WAIT 178.. autodata:: SD_RESULT_ID 179.. autodata:: SD_WILL_PUSH 180.. autodata:: SD_SUPPORTED_BINDING 181.. autodata:: SD_SUPPORTED_CONTENT 182.. autodata:: SD_SUPPORTED_PROTOCOL 183.. autodata:: SD_SUPPORTED_QUERY 184 185.. autodata:: SD_TYPES_11 186 187.. autodata:: SD_CAPABILITY_MODULE 188.. autodata:: SD_PREFERRED_SCOPE 189.. autodata:: SD_ALLOWED_SCOPE 190.. autodata:: SD_TARGETING_EXPRESSION_ID 191 192Query Formats 193************* 194 195These constants are used to indicate query format. 196 197..autodata:: FID_TAXII_DEFAULT_QUERY_10 198 199Query Capability Modules 200************************ 201 202These constants are used to indicate TAXII Default Query Capability Modules 203 204.. autodata:: CM_CORE 205.. autodata:: CM_REGEX 206.. autodata:: CM_TIMESTAMP 207 208.. autodata:: CM_IDS 209 210Query Operators 211*************** 212 213These constants are used to identify the operator in :py:class`Criteria` 214 215.. autodata:: OP_OR 216.. autodata:: OP_AND 217 218.. autodata:: OP_TYPES 219 220Query Status Types 221****************** 222 223TAXII Default Query 1.0 identifies three additional Status Types: 224 225.. autodata:: ST_UNSUPPORTED_CAPABILITY_MODULE 226.. autodata:: ST_UNSUPPORTED_TARGETING_EXPRESSION 227.. autodata:: ST_UNSUPPORTED_TARGETING_EXPRESSION_ID 228 229 230Query Parameters 231**************** 232 233These constants are used to identify parameters. 234 235.. autodata:: P_VALUE 236.. autodata:: P_MATCH_TYPE 237.. autodata:: P_CASE_SENSITIVE 238 239.. autodata:: P_NAMES 240 241Query Relationships 242******************* 243 244These constants are used to identify relationships 245 246.. autodata:: R_EQUALS 247.. autodata:: R_NOT_EQUALS 248.. autodata:: R_GREATER_THAN 249.. autodata:: R_GREATER_THAN_OR_EQUAL 250.. autodata:: R_LESS_THAN 251.. autodata:: R_LESS_THAN_OR_EQUAL 252.. autodata:: R_DOES_NOT_EXIST 253.. autodata:: R_EXISTS 254.. autodata:: R_BEGINS_WITH 255.. autodata:: R_ENDS_WITH 256.. autodata:: R_CONTAINS 257.. autodata:: R_MATCHES 258 259.. autodata:: R_NAMES 260