comparison env/lib/python3.7/site-packages/boto/auth_handler.py @ 5:9b1c78e6ba9c draft default tip

"planemo upload commit 6c0a8142489327ece472c84e558c47da711a9142"
author shellac
date Mon, 01 Jun 2020 08:59:25 -0400
parents 79f47841a781
children
comparison
equal deleted inserted replaced
4:79f47841a781 5:9b1c78e6ba9c
1 # Copyright 2010 Google Inc.
2 #
3 # Permission is hereby granted, free of charge, to any person obtaining a
4 # copy of this software and associated documentation files (the
5 # "Software"), to deal in the Software without restriction, including
6 # without limitation the rights to use, copy, modify, merge, publish, dis-
7 # tribute, sublicense, and/or sell copies of the Software, and to permit
8 # persons to whom the Software is furnished to do so, subject to the fol-
9 # lowing conditions:
10 #
11 # The above copyright notice and this permission notice shall be included
12 # in all copies or substantial portions of the Software.
13 #
14 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
15 # OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABIL-
16 # ITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
17 # SHALL THE AUTHOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
18 # WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
20 # IN THE SOFTWARE.
21
22 """
23 Defines an interface which all Auth handlers need to implement.
24 """
25
26 from boto.plugin import Plugin
27
28
29 class NotReadyToAuthenticate(Exception):
30 pass
31
32
33 class AuthHandler(Plugin):
34
35 capability = []
36
37 def __init__(self, host, config, provider):
38 """Constructs the handlers.
39 :type host: string
40 :param host: The host to which the request is being sent.
41
42 :type config: boto.pyami.Config
43 :param config: Boto configuration.
44
45 :type provider: boto.provider.Provider
46 :param provider: Provider details.
47
48 Raises:
49 NotReadyToAuthenticate: if this handler is not willing to
50 authenticate for the given provider and config.
51 """
52 pass
53
54 def add_auth(self, http_request):
55 """Invoked to add authentication details to request.
56
57 :type http_request: boto.connection.HTTPRequest
58 :param http_request: HTTP request that needs to be authenticated.
59 """
60 pass