StackStorm /
st2
| Conditions | 16 |
| Total Lines | 100 |
| Lines | 0 |
| Ratio | 0 % |
| Changes | 2 | ||
| Bugs | 0 | Features | 0 |
Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.
For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.
Commonly applied refactorings include:
If many parameters/temporary variables are present:
Complex classes like StandaloneAuthHandler.handle_auth() often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
| 1 | # Licensed to the StackStorm, Inc ('StackStorm') under one or more |
||
| 70 | def handle_auth(self, request, headers=None, remote_addr=None, remote_user=None, |
||
| 71 | authorization=None, **kwargs): |
||
| 72 | auth_backend = self._auth_backend.__class__.__name__ |
||
| 73 | |||
| 74 | extra = {'auth_backend': auth_backend, 'remote_addr': remote_addr} |
||
| 75 | |||
| 76 | if not authorization: |
||
| 77 | LOG.audit('Authorization header not provided', extra=extra) |
||
| 78 | abort_request() |
||
| 79 | return |
||
| 80 | |||
| 81 | auth_type, auth_value = authorization |
||
|
Bug
Best Practice
introduced
by
|
|||
| 82 | if auth_type.lower() not in ['basic']: |
||
| 83 | extra['auth_type'] = auth_type |
||
| 84 | LOG.audit('Unsupported authorization type: %s' % (auth_type), extra=extra) |
||
| 85 | abort_request() |
||
| 86 | return |
||
| 87 | |||
| 88 | try: |
||
| 89 | auth_value = base64.b64decode(auth_value) |
||
| 90 | except Exception: |
||
| 91 | LOG.audit('Invalid authorization header', extra=extra) |
||
| 92 | abort_request() |
||
| 93 | return |
||
| 94 | |||
| 95 | split = auth_value.split(':') |
||
| 96 | if len(split) != 2: |
||
| 97 | LOG.audit('Invalid authorization header', extra=extra) |
||
| 98 | abort_request() |
||
| 99 | return |
||
| 100 | |||
| 101 | username, password = split |
||
| 102 | result = self._auth_backend |
||
| 103 | |||
| 104 | result = self._auth_backend.authenticate(username=username, password=password) |
||
| 105 | if result is True: |
||
| 106 | ttl = getattr(request, 'ttl', None) |
||
| 107 | impersonate_user = getattr(request, 'user', None) |
||
| 108 | |||
| 109 | if impersonate_user is not None: |
||
| 110 | # check this is a service account |
||
| 111 | try: |
||
| 112 | if not User.get_by_name(username).is_service: |
||
| 113 | message = "Current user is not a service and cannot " \ |
||
| 114 | "request impersonated tokens" |
||
| 115 | abort_request(status_code=http_client.BAD_REQUEST, |
||
| 116 | message=message) |
||
| 117 | return |
||
| 118 | username = impersonate_user |
||
| 119 | except (UserNotFoundError, StackStormDBObjectNotFoundError): |
||
| 120 | message = "Could not locate user %s" % \ |
||
| 121 | (impersonate_user) |
||
| 122 | abort_request(status_code=http_client.BAD_REQUEST, |
||
| 123 | message=message) |
||
| 124 | return |
||
| 125 | else: |
||
| 126 | impersonate_user = getattr(request, 'impersonate_user', None) |
||
| 127 | nickname_origin = getattr(request, 'nickname_origin', None) |
||
| 128 | if impersonate_user is not None: |
||
| 129 | try: |
||
| 130 | # check this is a service account |
||
| 131 | if not User.get_by_name(username).is_service: |
||
| 132 | raise NotServiceUserError() |
||
| 133 | username = User.get_by_nickname(impersonate_user, |
||
| 134 | nickname_origin).name |
||
| 135 | except NotServiceUserError: |
||
| 136 | message = "Current user is not a service and cannot " \ |
||
| 137 | "request impersonated tokens" |
||
| 138 | abort_request(status_code=http_client.BAD_REQUEST, |
||
| 139 | message=message) |
||
| 140 | return |
||
| 141 | except (UserNotFoundError, StackStormDBObjectNotFoundError): |
||
| 142 | message = "Could not locate user %s@%s" % \ |
||
| 143 | (impersonate_user, nickname_origin) |
||
| 144 | abort_request(status_code=http_client.BAD_REQUEST, |
||
| 145 | message=message) |
||
| 146 | return |
||
| 147 | except NoNicknameOriginProvidedError: |
||
| 148 | message = "Nickname origin is not provided for nickname '%s'" % \ |
||
| 149 | impersonate_user |
||
| 150 | abort_request(status_code=http_client.BAD_REQUEST, |
||
| 151 | message=message) |
||
| 152 | return |
||
| 153 | except AmbiguousUserError: |
||
| 154 | message = "%s@%s matched more than one username" % \ |
||
| 155 | (impersonate_user, nickname_origin) |
||
| 156 | abort_request(status_code=http_client.BAD_REQUEST, |
||
| 157 | message=message) |
||
| 158 | return |
||
| 159 | try: |
||
| 160 | token = self._create_token_for_user( |
||
| 161 | username=username, ttl=ttl) |
||
| 162 | return token |
||
| 163 | except TTLTooLargeException as e: |
||
| 164 | abort_request(status_code=http_client.BAD_REQUEST, |
||
| 165 | message=e.message) |
||
| 166 | return |
||
| 167 | |||
| 168 | LOG.audit('Invalid credentials provided', extra=extra) |
||
| 169 | abort_request() |
||
| 170 |
Loading history...