Functions
def	clean_acl

def	parse_acl

def	referrer_allowed

Function Documentation

def swift.common.middleware.acl.clean_acl	(	name,
		value
	)

Returns a cleaned ACL header value, validating that it meets the formatting
requirements for standard Swift ACL strings.

The ACL format is::

    [item[,item...]]

Each item can be a group name to give access to or a referrer designation
to grant or deny based on the HTTP Referer header.

The referrer designation format is::

    .r:[-]value

The ``.r`` can also be ``.ref``, ``.referer``, or ``.referrer``; though it
will be shortened to just ``.r`` for decreased character count usage.

The value can be ``*`` to specify any referrer host is allowed access, a
specific host name like ``www.example.com``, or if it has a leading period
``.`` or leading ``*.`` it is a domain name specification, like
``.example.com`` or ``*.example.com``. The leading minus sign ``-``
indicates referrer hosts that should be denied access.

Referrer access is applied in the order they are specified. For example,
.r:.example.com,.r:-thief.example.com would allow all hosts ending with
.example.com except for the specific host thief.example.com.

Example valid ACLs::

    .r:*
    .r:*,.r:-.thief.com
    .r:*,.r:.example.com,.r:-thief.example.com
    .r:*,.r:-.thief.com,bobs_account,sues_account:sue
    bobs_account,sues_account:sue

Example invalid ACLs::

    .r:
    .r:-

By default, allowing read access via .r will not allow listing objects in
the container -- just retrieving objects from the container. To turn on
listings, use the .rlistings directive.

Also, .r designations aren't allowed in headers whose names include the
word 'write'.

ACLs that are "messy" will be cleaned up. Examples:

======================  ======================
Original                Cleaned
----------------------  ----------------------
``bob, sue``            ``bob,sue``
``bob , sue``           ``bob,sue``
``bob,,,sue``           ``bob,sue``
``.referrer : *``       ``.r:*``
``.ref:*.example.com``  ``.r:.example.com``
``.r:*, .rlistings``    ``.r:*,.rlistings``
======================  ======================

:param name: The name of the header being cleaned, such as X-Container-Read
             or X-Container-Write.
:param value: The value of the header being cleaned.
:returns: The value, cleaned of extraneous formatting.
:raises ValueError: If the value does not meet the ACL formatting
                    requirements; the error message will indicate why.

Definition at line 19 of file acl.py.

def swift.common.middleware.acl.parse_acl ( acl_string)

Parses a standard Swift ACL string into a referrers list and groups list.

See :func:`clean_acl` for documentation of the standard Swift ACL format.

:param acl_string: The standard Swift ACL string to parse.
:returns: A tuple of (referrers, groups) where referrers is a list of
          referrer designations (without the leading .r:) and groups is a
          list of groups to allow access.

Definition at line 120 of file acl.py.

Referenced by swift.common.middleware.tempauth.TempAuth.authorize().

def swift.common.middleware.acl.referrer_allowed	(	referrer,
		referrer_acl
	)

Returns True if the referrer should be allowed based on the referrer_acl
list (as returned by :func:`parse_acl`).

See :func:`clean_acl` for documentation of the standard Swift ACL format.

:param referrer: The value of the HTTP Referer header.
:param referrer_acl: The list of referrer designations as returned by
                     :func:`parse_acl`.
:returns: True if the referrer should be allowed; False if not.

Definition at line 142 of file acl.py.

References swift.common.utils.urlparse().

Referenced by swift.common.middleware.tempauth.TempAuth.authorize().

Functions

Function Documentation