Auth Plugins / Plugin Cleanup #172
Merged
Conversation
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
|
@DirectXMan12 I did a brief scan of the change and it looks good to me. Maybe a test for this? |
|
@kanaka : I'll write up a couple tests. |
Auth plugins provide a generic interface for authenticating requests. The plugin name is specified using the '--auth-plugin' option, and may either be the name of a class from `websockify.auth_plugins`, or a fully qualified python path to the auth plugin class (see below). An optional plugin parameter can be specified using the '--auth-source' option (a value of `None` will be used if no '--auth-source' option is specified). Auth plugins should inherit from `websockify.auth_plugins.BasePlugin`, and should implement the `authenticate(headers, target_host, target_port)` method. The value of the '--auth-source' option is available as `self.source`. One plugin is currently included: `ExpectOrigin`. The `ExpectOrigin` plugin checks that the 'Origin' header is an expected value. The list of acceptable origins is passed using the plugin source, as a space-separated list.
ReadOnlyTokenFile didn't initialize `self._targets` to `None`, causing issues.
Previously, we just passed the values of '--*-plugin' and '--*-source' directly to `LibProxyServer` and `WebSocketProxy`, which handled turning that into an instance of the plugin class. Now, that's done in main, and the classes receive an instance directly.
This commit updates the unit tests to work with the current code and adds in tests for the auth and token plugin functionality.
This commit enables running the unit tests on Travis for Python 2.6, 2.7, 3.3, and 3.4. Note that Travis does not support Python 2.4, so we cannot test there.
DirectXMan12
force-pushed
the
feature/generic-auth-hook
branch
from
a701829 to
afb5d28
Compare
|
Ok, I rewrote the tests to actually work, and enabled Travis along the way |
This was referenced May 12, 2015
Merged
DirectXMan12
added a commit
that referenced
this pull request
May 13, 2015
Auth Plugins / Plugin Cleanup / Test Update
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR introduces auth hooks, with allow websockify users to easily add in arbitrary authentication without having to subclass the main classes of websockify. Authentication plugins are passed the header object, as well as the target host and port. When initialized, they are passed a single parameter, similarly to token plugins. If authentication fails, auth plugins should raise an exception.