dist/*

django_oauth.egg-info/*

setuptools_hg-0.1-py2.5.egg

"""

The MIT License

Copyright (c) 2007 Leah Culver

Permission is hereby granted, free of charge, to any person obtaining a copy

of this software and associated documentation files (the "Software"), to deal

in the Software without restriction, including without limitation the rights

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the Software is

furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in

all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN

THE SOFTWARE.

"""

    """Generic exception class."""

    """Optional WWW-Authenticate header (401 error)"""

    """Escape a URL including any /."""

def _utf8_str(s):

    """Convert unicode to utf-8."""

    if isinstance(s, unicode):

        return s.encode("utf-8")

    else:

        return str(s)

    """Get seconds since epoch (UTC)."""

    """Generate pseudorandom number."""

def generate_verifier(length=8):

    """Generate pseudorandom number."""

    return ''.join([str(random.randint(0, 9)) for i in range(length)])

    """Consumer of OAuth authentication.

    OAuthConsumer is a data type that represents the identity of the Consumer

    via its shared secret with the Service Provider.

    """

    """OAuthToken is a data type that represents an End User via either an access

    or request token.

    key -- the token

    secret -- the token secret

    """

    callback = None

    callback_confirmed = None

    verifier = None

    def set_callback(self, callback):

        self.callback = callback

        self.callback_confirmed = 'true'

    def set_verifier(self, verifier=None):

        if verifier is not None:

            self.verifier = verifier

        else:

            self.verifier = generate_verifier()

    def get_callback_url(self):

        if self.callback and self.verifier:

            # Append the oauth_verifier.

            parts = urlparse.urlparse(self.callback)

            scheme, netloc, path, params, query, fragment = parts[:6]

            if query:

                query = '%s&oauth_verifier=%s' % (query, self.verifier)

            else:

                query = 'oauth_verifier=%s' % self.verifier

            return urlparse.urlunparse((scheme, netloc, path, params,

                query, fragment))

        return self.callback

        data = {

            'oauth_token': self.key,

            'oauth_token_secret': self.secret,

        }

        if self.callback_confirmed is not None:

            data['oauth_callback_confirmed'] = self.callback_confirmed

        return urllib.urlencode(data)

        """ Returns a token from something like:

        oauth_token_secret=xxx&oauth_token=xxx

        """

        token = OAuthToken(key, secret)

        try:

            token.callback_confirmed = params['oauth_callback_confirmed'][0]

        except KeyError:

            pass # 1.0, no callback confirmed.

        return token

    """OAuthRequest represents the request and can be serialized.

        - oauth_verifier

    """

    parameters = None # OAuth parameters.

        return self.get_parameter('oauth_timestamp'), self.get_parameter(

            'oauth_nonce')

        """Get any non-OAuth parameters."""

            # Ignore oauth parameters.

        """Serialize as a header for an HTTPAuth request."""

        # Add the oauth parameters.

        """Serialize as post data for a POST request."""

        return '&'.join(['%s=%s' % (escape(str(k)), escape(str(v))) \

            for k, v in self.parameters.iteritems()])

        """Serialize as a URL for a GET request."""

        """Return a string that contains the parameters that must be signed."""

            # Exclude the signature if it exists.

        # Escape key values before sorting.

        key_values = [(escape(_utf8_str(k)), escape(_utf8_str(v))) \

            for k,v in params.items()]

        # Sort lexicographically, first after key, then after value.

        # Combine key value pairs into a string.

        return '&'.join(['%s=%s' % (k, v) for k, v in key_values])

        """Uppercases the http method."""

        """Parses the URL and rebuilds it to be scheme://host/path."""

        scheme, netloc, path = parts[:3]

        # Exclude default port numbers.

        if scheme == 'http' and netloc[-3:] == ':80':

            netloc = netloc[:-3]

        elif scheme == 'https' and netloc[-4:] == ':443':

            netloc = netloc[:-4]

        return '%s://%s%s' % (scheme, netloc, path)

        """Set the signature parameter to the result of build_signature."""

        # Set the signature method.

        self.set_parameter('oauth_signature_method',

            signature_method.get_name())

        # Set the signature.

        self.set_parameter('oauth_signature',

            self.build_signature(signature_method, consumer, token))

        """Calls the build signature method within the signature method."""

    def from_request(http_method, http_url, headers=None, parameters=None,

            query_string=None):

        """Combines multiple parameter sources."""

        # Headers

            # Check that the authorization header is OAuth.

            if auth_header[:6] == 'OAuth ':

                auth_header = auth_header[6:]

                    # Get the parameters from the header.

                    raise OAuthError('Unable to parse OAuth parameters from '

                        'Authorization header.')

        # GET or POST query string.

        # URL parameters.

    def from_consumer_and_token(oauth_consumer, token=None,

            callback=None, verifier=None, http_method=HTTP_METHOD,

            http_url=None, parameters=None):

            if token.callback:

                parameters['oauth_callback'] = token.callback

            # 1.0a support for verifier.

            if verifier:

                parameters['oauth_verifier'] = verifier

        elif callback:

            # 1.0a support for callback in the request token request.

            parameters['oauth_callback'] = callback

    def from_token_and_callback(token, callback=None, http_method=HTTP_METHOD,

            http_url=None, parameters=None):

        """Turn Authorization: header into parameters."""

            # Ignore realm parameter.

            if param.find('realm') > -1:

            # Remove whitespace.

            # Split key-value.

            # Remove quotes and unescape the value.

        """Turn URL string into parameters."""

    """A worker to check the validity of a request against a data store."""

    timestamp_threshold = 300 # In seconds, five minutes.

        """Processes a request_token request and returns the

        request token on success.

        """

            # Get the request token for authorization.

            # No token required for the initial token request.

            try:

                callback = self.get_callback(oauth_request)

            except OAuthError:

                callback = None # 1.0, no callback specified.

            # Fetch a new token.

            token = self.data_store.fetch_request_token(consumer, callback)

        """Processes an access_token request and returns the

        access token on success.

        """

        try:

            verifier = self._get_verifier(oauth_request)

        except OAuthError:

            verifier = None

        # Get the request token.

        new_token = self.data_store.fetch_access_token(consumer, token, verifier)

        """Verifies an api call and checks all the parameters."""

        # Get the access token.

        """Authorize a request token."""

        """Get the callback URL."""

        """Optional support for the authenticate header."""

        """Verify the correct version request for this server."""

        """Figure out the signature with some defaults."""

            signature_method = oauth_request.get_parameter(

                'oauth_signature_method')

            # Get the signature method object.

            raise OAuthError('Signature method %s not supported try one of the '

                'following: %s' % (signature_method, signature_method_names))

        """Try to find the token for the provided request token key."""

    def _get_verifier(self, oauth_request):

        return oauth_request.get_parameter('oauth_verifier')

        # Validate the signature.

        valid_sig = signature_method.check_signature(oauth_request, consumer,

            token, signature)

            key, base = signature_method.build_signature_base_string(

                oauth_request, consumer, token)

            raise OAuthError('Invalid signature. Expected signature base '

                'string: %s' % base)

        """Verify that timestamp is recentish."""

            raise OAuthError('Expired timestamp: given %d and now %s has a '

                'greater difference than threshold %d' %

                (timestamp, now, self.timestamp_threshold))

        """Verify that the nonce is uniqueish."""

    """OAuthClient is a worker to attempt to execute a request."""

        """-> OAuthToken."""

        """-> OAuthToken."""

        """-> Some protected resource."""

    """A database abstraction used to lookup consumers and tokens."""

        """-> OAuthConsumer."""

        """-> OAuthToken."""

    def lookup_nonce(self, oauth_consumer, oauth_token, nonce):

        """-> OAuthToken."""

    def fetch_request_token(self, oauth_consumer, oauth_callback):

        """-> OAuthToken."""

    def fetch_access_token(self, oauth_consumer, oauth_token, oauth_verifier):

        """-> OAuthToken."""

        """-> OAuthToken."""

    """A strategy class that implements a signature method."""

        """-> str."""

        """-> str key, str raw."""

        """-> str."""

        """Builds the base signature string."""

        key, raw = self.build_signature_base_string(oauth_request, consumer,

            token)

        # HMAC object.

            import sha # Deprecated

        # Calculate the digest base 64.

        """Concatenates the consumer key and secret."""

        key, raw = self.build_signature_base_string(oauth_request, consumer,

            token)

    def fetch_request_token(self, oauth_consumer, oauth_callback):

    def fetch_access_token(self, oauth_consumer, oauth_token, oauth_verifier):