Source code for

User password Security Helper

__author__ = 'VMware, Inc.'
__copyright__ = 'Copyright (c) 2015 VMware, Inc.  All rights reserved.'

from vmware.vapi.core import SecurityContext
from vmware.vapi.lib.constants import SCHEME_ID
from import SecurityContextParser

USER_KEY = 'userName'
PASSWORD_KEY = 'password'
REST_USERNAME = 'username'
REST_PASSWORD = 'password'

[docs]def create_user_password_security_context(user_name, password): """ Create a security context for Username-Password based authentication scheme :type user_name: :class:`str` :param user_name: Name of the user :type password: :class:`str` :param password: Password of the user :rtype: :class:`vmware.vapi.core.SecurityContext` :return: Newly created security context """ return SecurityContext({SCHEME_ID: USER_PASSWORD_SCHEME_ID, USER_KEY: user_name, PASSWORD_KEY: password})
[docs]class UserPasswordSecurityContextParser(SecurityContextParser): """ Security context parser used by the REST presentation layer that builds a security context if the REST request has username/password credentials in the HTTP header. """ def __init__(self): """ Initialize UserPasswordSecurityContextParser """ SecurityContextParser.__init__(self)
[docs] def build(self, request): """ Build the security context if the request has authorization header that contains base64 encoded string of username/password. If the request authorization header doesn't have the username/password, this method returns None. :type request: :class:`werkzeug.wrappers.Request` :param request: Request object :rtype: :class:`vmware.vapi.core.SecurityContext` or ``None`` :return: Security context object """ if request.authorization: username = request.authorization.get(REST_USERNAME) password = request.authorization.get(REST_PASSWORD) if username is not None and password is not None: return create_user_password_security_context(username, password)