-
-
Notifications
You must be signed in to change notification settings - Fork 745
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
add keystone auth backend #1732
Merged
Merged
Changes from 1 commit
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
3e7b68c
add keystone auth backend
e58effe
add support for v2/v3 keystone, add tests with mocking. Hope thye wor…
6ed8e25
fix messed up flake8
5ecf6de
set pylint to ignore the importerrors as they are there for python3
adb44ee
forgot that when patching, mock is passed to the function!
2937e88
Im dumb and cant read variable names
bfe23a0
use httplib for the http codes, use six for easier py2/3 compatibility
8ea82ca
wrong import
9e8c55b
REALLY fix the wrong import
f4f7e3d
use httlib for status_code, use proper key for keystone v2
e31ed58
some linting
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
# Licensed to the StackStorm, Inc ('StackStorm') under one or more | ||
# contributor license agreements. See the NOTICE file distributed with | ||
# this work for additional information regarding copyright ownership. | ||
# The ASF licenses this file to You under the Apache License, Version 2.0 | ||
# (the "License"); you may not use this file except in compliance with | ||
# the License. You may obtain a copy of the License at | ||
# | ||
# http://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, software | ||
# distributed under the License is distributed on an "AS IS" BASIS, | ||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
# See the License for the specific language governing permissions and | ||
# limitations under the License. | ||
|
||
|
||
from st2common import log as logging | ||
from st2auth.backends.base import BaseAuthenticationBackend | ||
import requests | ||
|
||
__all__ = [ | ||
'KeystoneAuthenticationBackend' | ||
] | ||
|
||
LOG = logging.getLogger(__name__) | ||
|
||
|
||
class KeystoneAuthenticationBackend(BaseAuthenticationBackend): | ||
""" | ||
Backend which reads authentication information from keystone | ||
|
||
Note: This backend depends on the "requests" library. | ||
""" | ||
|
||
def __init__(self, keystone_url, keystone_version=2): | ||
""" | ||
:param keystone_url: Url of the Keystone server to authenticate against. | ||
:type keystone_url: ``str`` | ||
:param keystone_version: Keystone version to authenticate against (default to 2). | ||
:type keystone_version: ``int`` | ||
""" | ||
self._keystone_url = keystone_url | ||
self._keystone_version = keystone_version | ||
|
||
def authenticate(self, username, password): | ||
creds = { | ||
"auth": { | ||
"passwordCredentials": { | ||
"username": username, | ||
"password": password | ||
} | ||
} | ||
} | ||
login = requests.post(self._keystone_url, json=creds) | ||
|
||
if login.status_code == 200: | ||
LOG.debug('Authentication for user "{}" successful'.format(username)) | ||
return True | ||
else: | ||
LOG.debug('Authentication for user "{}" failed: {}'.format(username, login.content)) | ||
return False | ||
|
||
def get_user(self, username): | ||
pass |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks like this argument is unused and we only support v2 right now?
If so, we should make that clear and throw if an unsupported version is provided.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
On a related note, it might be better to just use python-keystoneclient.
Ideally, eventually we would also switch to using setup.py entry_points for plugins and provide plugins as separate Python packages with it's own requirements.txt file, but for now I'm OK with putting keystone-client dependency to the shared requirements.txt file.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actually, Im doing the v2/v3 split now and some other checks. I wanted the PR to go up quick due to the testing question.
Re: keystone client. Totally against that tbh. It turns a simple authentication plugin with one dependency into dependency hell and also ties into a big external projects, while requests is one package with minimal dependencies and probably already installed on every decent python env which needs to do a network call.
And this auth backend just needs to do one simple call. To have keystoneclient as dependency is overkill IMO.