interface documentation

class ISessionSetEnv(Interface): (source)

View In Hierarchy

A session that can set environment variables.

Method setEnv Set an environment variable for the shell or command to be started.
def setEnv(name, value): (source)

Set an environment variable for the shell or command to be started.

From RFC 4254, section 6.4: "Uncontrolled setting of environment variables in a privileged process can be a security hazard. It is recommended that implementations either maintain a list of allowable variable names or only set environment variables after the server process has dropped sufficient privileges."

(OpenSSH refuses all environment variables by default, but has an AcceptEnv configuration option to select specific variables to accept.)

Parameters
name:bytesThe name of the environment variable to set.
value:bytesThe value of the environment variable to set.
Raises
EnvironmentVariableNotPermittedif setting this environment variable is not permitted.