Misc

ACLs

Buffered HTTP

Constraints

Container Sync Realms

Digest

Direct Client

Exceptions

Internal Client

Manager

MemCacheD

Middleware Registry

swift.common.registry.get_sensitive_headers()

Returns the set of registered sensitive headers.

Used by swift.common.middleware.proxy_logging to perform redactions prior to logging.

swift.common.registry.get_sensitive_params()

Returns the set of registered sensitive query parameters.

Used by swift.common.middleware.proxy_logging to perform redactions prior to logging.

swift.common.registry.get_swift_info(admin=False, disallowed_sections=None)

Returns information about the swift cluster that has been previously registered with the register_swift_info call.

Parameters:
  • admin – boolean value, if True will additionally return an ‘admin’ section with information previously registered as admin info.

  • disallowed_sections – list of section names to be withheld from the information returned.

Returns:

dictionary of information about the swift cluster.

swift.common.registry.register_sensitive_header(header)

Register a header as being “sensitive”.

Sensitive headers are automatically redacted when logging. See the reveal_sensitive_prefix option in the proxy-server sample config for more information.

Parameters:

header – The (case-insensitive) header name which, if present, may contain sensitive information. Examples include X-Auth-Token and (if s3api is enabled) Authorization. Limited to ASCII characters.

swift.common.registry.register_sensitive_param(query_param)

Register a query parameter as being “sensitive”.

Sensitive query parameters are automatically redacted when logging. See the reveal_sensitive_prefix option in the proxy-server sample config for more information.

Parameters:

query_param – The (case-sensitive) query parameter name which, if present, may contain sensitive information. Examples include temp_url_signature and (if s3api is enabled) X-Amz-Signature. Limited to ASCII characters.

swift.common.registry.register_swift_info(name='swift', admin=False, **kwargs)

Registers information about the swift cluster to be retrieved with calls to get_swift_info.

NOTE: Do not use “.” in the param: name or any keys in kwargs. “.” is used

in the disallowed_sections to remove unwanted keys from /info.

Parameters:
  • name – string, the section name to place the information under.

  • admin – boolean, if True, information will be registered to an admin section which can optionally be withheld when requesting the information.

  • kwargs – key value arguments representing the information to be added.

Raises:

ValueError – if name or any of the keys in kwargs has “.” in it

Request Helpers

Swob

Utils

WSGI

Storage Policy