mirror of
https://github.com/python/cpython.git
synced 2026-01-06 15:32:22 +00:00
Document that the key should not contain null bytes.
This commit is contained in:
parent
db9198a8b5
commit
a861d552c3
1 changed files with 3 additions and 2 deletions
|
|
@ -29,7 +29,8 @@ The available functions in this module are:
|
|||
|
||||
\begin{funcdesc}{newrotor}{key\optional{, numrotors}}
|
||||
Return a rotor object. \var{key} is a string containing the encryption key
|
||||
for the object; it can contain arbitrary binary data. The key will be used
|
||||
for the object; it can contain arbitrary binary data but not null bytes.
|
||||
The key will be used
|
||||
to randomly generate the rotor permutations and their initial positions.
|
||||
\var{numrotors} is the number of rotor permutations in the returned object;
|
||||
if it is omitted, a default value of 6 will be used.
|
||||
|
|
@ -38,7 +39,7 @@ if it is omitted, a default value of 6 will be used.
|
|||
Rotor objects have the following methods:
|
||||
|
||||
\begin{methoddesc}[rotor]{setkey}{key}
|
||||
Sets the rotor's key to \var{key}.
|
||||
Sets the rotor's key to \var{key}. The key should not contain null bytes.
|
||||
\end{methoddesc}
|
||||
|
||||
\begin{methoddesc}[rotor]{encrypt}{plaintext}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue