Crate bulwark_sdk

This crate provides the logic for Bulwark’s guest environment.

Re-exports

• pub use http;

Modules

• redis

Macros

• error
  Construct an ad-hoc error from a string or existing non-anyhow error value.
• value
  Construct a serde_json::Value from a JSON literal.

Structs

• Decision
  A Decision represents evidence in favor of either accepting or restricting an operation under consideration.
• Extensions
  A type map of protocol extensions.
• HandlerOutput
  A HandlerOutput represents a decision and associated output for a single handler within a single detection.
• Map
  Represents a JSON key/value type.
• Method
  The Request Method (VERB)
• StatusCode
  An HTTP status code (status-code in RFC 7230 et al.).
• Uri
  The URI component of a request.
• Verdict
  A Verdict represents a combined decision across multiple detections.
• Version
  Represents a version of the HTTP spec.

Enums

• Outcome
  Represents a value from a continuous range taken from the pignistic transformation as a category that can be used to select a response to an operation.
• ParseCounterError
  Returned when an attempt to parse a counter within a plugin environment fails.
• RemoteStateError
  Returned when there is an issue with the remote state requested by the plugin.
• ThresholdError
  Returned when a threshold is either out-of-order or out-of-range.
• Value
  Represents any valid JSON value.

Constants

• ACCEPT
  A decision representing acceptance with full certainty.
• RESTRICT
  A decision representing restriction with full certainty.
• UNKNOWN
  A decision representing full uncertainty.

Functions

• client_ip
  Returns the true remote client IP address.
• config_keys
  Returns all of the plugin’s configuration key names.
• config_var
  Returns a named plugin configuration value as a Value.

Type Aliases

• Bytes
  A type alias. See bytes::Bytes for details.
• Error
  Generic error
• Request
  An HTTP request combines a head consisting of a Method, Uri, and headers with Bytes, which provides access to the first chunk of a request body.
• Response
  An HTTP response combines a head consisting of a StatusCode and headers with Bytes, which provides access to the first chunk of a response body.

Attribute Macros

• bulwark_plugin
  The bulwark_plugin attribute generates default implementations for all handler traits in a module and produces friendly errors for common mistakes.