PROTON-1522: Document user and password args to reactor connect; warn users not to put users and passwords in URLs
Project: http://git-wip-us.apache.org/repos/asf/qpid-proton/repo Commit: http://git-wip-us.apache.org/repos/asf/qpid-proton/commit/7a936e9c Tree: http://git-wip-us.apache.org/repos/asf/qpid-proton/tree/7a936e9c Diff: http://git-wip-us.apache.org/repos/asf/qpid-proton/diff/7a936e9c Branch: refs/heads/go1 Commit: 7a936e9ce15372182a630761e6713af04401d119 Parents: 1eb8a7b Author: Justin Ross <[email protected]> Authored: Fri Dec 8 09:51:12 2017 -0800 Committer: Justin Ross <[email protected]> Committed: Fri Dec 8 09:51:12 2017 -0800 ---------------------------------------------------------------------- proton-c/bindings/python/proton/__init__.py | 4 ++++ proton-c/bindings/python/proton/reactor.py | 16 +++++++++------- 2 files changed, 13 insertions(+), 7 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/7a936e9c/proton-c/bindings/python/proton/__init__.py ---------------------------------------------------------------------- diff --git a/proton-c/bindings/python/proton/__init__.py b/proton-c/bindings/python/proton/__init__.py index 3671e2b..21076ee 100644 --- a/proton-c/bindings/python/proton/__init__.py +++ b/proton-c/bindings/python/proton/__init__.py @@ -4172,6 +4172,10 @@ class Url(object): The port can be specified as a service name, e.g. 'amqp' in the URL string but Url.port always gives the integer value. + Warning: The placement of user and password in URLs is not + recommended. It can result in credentials leaking out in program + logs. Use connection configuration attributes instead. + @ivar scheme: Url scheme e.g. 'amqp' or 'amqps' @ivar user: Username @ivar password: Password http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/7a936e9c/proton-c/bindings/python/proton/reactor.py ---------------------------------------------------------------------- diff --git a/proton-c/bindings/python/proton/reactor.py b/proton-c/bindings/python/proton/reactor.py index 58045e9..e9ede47 100644 --- a/proton-c/bindings/python/proton/reactor.py +++ b/proton-c/bindings/python/proton/reactor.py @@ -715,15 +715,17 @@ class Container(Reactor): called to process any events in the scope of this connection or its child links - @param kwargs: sasl_enabled, which determines whether a sasl - layer is used for the connection; allowed_mechs an optional + @param kwargs: 'sasl_enabled', which determines whether a sasl + layer is used for the connection; 'allowed_mechs', an optional string containing a space-separated list of SASL mechanisms to - allow if sasl is enabled; allow_insecure_mechs a flag + allow if sasl is enabled; 'allow_insecure_mechs', a flag indicating whether insecure mechanisms, such as PLAIN over a - non-encrypted socket, are allowed; 'virtual_host' the hostname - to set in the Open performative used by peer to determine the - correct back-end service for the client. If 'virtual_host' is - not supplied the host field from the URL is used instead." + non-encrypted socket, are allowed; 'virtual_host', the + hostname to set in the Open performative used by peer to + determine the correct back-end service for the client. If + 'virtual_host' is not supplied the host field from the URL is + used instead; 'user', the user to authenticate; 'password', + the authentication secret. """ conn = self.connection(handler) --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
