summaryrefslogtreecommitdiff
path: root/paramiko/channel.py
diff options
context:
space:
mode:
authorJeff Forcier <jeff@bitprophet.org>2016-12-01 13:27:58 -0800
committerJeff Forcier <jeff@bitprophet.org>2016-12-05 18:45:23 -0800
commitaf455259c15edb38239083314a8b9e91cd0d3f06 (patch)
treed1775893a03edceada82ad58415fec0c15dcab5d /paramiko/channel.py
parent4a2747fbcb817f8654c285838e5a37eb4dff02a9 (diff)
downloadparamiko-af455259c15edb38239083314a8b9e91cd0d3f06.tar.gz
Add some warnings about AcceptEnv to env var setting bits.
Re #398
Diffstat (limited to 'paramiko/channel.py')
-rw-r--r--paramiko/channel.py10
1 files changed, 10 insertions, 0 deletions
diff --git a/paramiko/channel.py b/paramiko/channel.py
index 7689b266..3b6a59df 100644
--- a/paramiko/channel.py
+++ b/paramiko/channel.py
@@ -292,6 +292,10 @@ class Channel (ClosingContextManager):
This operation is additive - i.e. the current environment is not
reset before the given environment variables are set.
+ .. warning::
+ Servers may silently reject some environment variables; see the
+ warning in `set_environment_variable` for details.
+
:param dict environment:
a dictionary containing the name and respective values to set
:raises SSHException:
@@ -310,6 +314,12 @@ class Channel (ClosingContextManager):
"""
Set the value of an environment variable.
+ .. warning::
+ The server may reject this request depending on its ``AcceptEnv``
+ setting; such rejections will fail silently (which is common client
+ practice for this particular request type). Make sure you
+ understand your server's configuration before using!
+
:param str name: name of the environment variable
:param str value: value of the environment variable