Package paramiko :: Module util
[show private | hide private]
[frames | no frames]

Module paramiko.util

Useful functions used by the rest of paramiko.
Classes
PFilter  

Function Summary
  bit_length(n)
  deflate_long(n, add_sign_padding)
turns a long-int into a normalized byte string (adapted from Crypto.Util.number)
  format_binary(data, prefix)
  format_binary_line(data)
  format_binary_weird(data)
string generate_key_bytes(hashclass, salt, key, nbytes)
Given a password, passphrase, or other human-source key, scramble it through a secure hash into some keyworthy bytes.
  get_logger(name)
  get_thread_id()
  hexify(s)
turn a string into a hex sequence
  inflate_long(s, always_positive)
turns a normalized byte string into a long-int (adapted from Crypto.Util.number)
dict(hostname, dict(keytype, PKey)) load_host_keys(filename)
Read a file of known SSH host keys, in the format used by openssh, and return a compound dict of hostname -> keytype -> PKey.
  log_to_file(filename, level)
send paramiko logs to a logfile, if they're not already going somewhere
  lookup_ssh_host_config(hostname, config)
Provided only as a backward-compatible wrapper around SSHConfig.
  mod_inverse(x, m)
  parse_ssh_config(file_obj)
Provided only as a backward-compatible wrapper around SSHConfig.
  safe_string(s)
  tb_strings()
  unhexify(s)
turn a hex sequence back into a string

Variable Summary
int _g_thread_counter = 0                                                                     
dict _g_thread_ids = {}
lock _g_thread_lock = <thread.lock object at 0x3b120>
PFilter _pfilter = <paramiko.util.PFilter object at 0x289750>

Function Details

deflate_long(n, add_sign_padding=True)

turns a long-int into a normalized byte string (adapted from Crypto.Util.number)

generate_key_bytes(hashclass, salt, key, nbytes)

Given a password, passphrase, or other human-source key, scramble it through a secure hash into some keyworthy bytes. This specific algorithm is used for encrypting/decrypting private key files.
Parameters:
hashclass - class from Crypto.Hash that can be used as a secure hashing function (like MD5 or SHA).
           (type=Crypto.Hash)
salt - data to salt the hash with.
           (type=string)
key - human-entered password or passphrase.
           (type=string)
nbytes - number of bytes to generate.
           (type=int)
Returns:
key data
           (type=string)

hexify(s)

turn a string into a hex sequence

inflate_long(s, always_positive=False)

turns a normalized byte string into a long-int (adapted from Crypto.Util.number)

load_host_keys(filename)

Read a file of known SSH host keys, in the format used by openssh, and return a compound dict of hostname -> keytype -> PKey. The hostname may be an IP address or DNS name. The keytype will be either "ssh-rsa" or "ssh-dss".

This type of file unfortunately doesn't exist on Windows, but on posix, it will usually be stored in os.path.expanduser("~/.ssh/known_hosts").

Since 1.5.3, this is just a wrapper around HostKeys.
Parameters:
filename - name of the file to read host keys from
           (type=str)
Returns:
dict of host keys, indexed by hostname and then keytype
           (type=dict(hostname, dict(keytype, PKey)))

log_to_file(filename, level=10)

send paramiko logs to a logfile, if they're not already going somewhere

lookup_ssh_host_config(hostname, config)

Provided only as a backward-compatible wrapper around SSHConfig.

parse_ssh_config(file_obj)

Provided only as a backward-compatible wrapper around SSHConfig.

unhexify(s)

turn a hex sequence back into a string

Variable Details

_g_thread_counter

Type:
int
Value:
0                                                                     

_g_thread_ids

Type:
dict
Value:
{}                                                                     

_g_thread_lock

Type:
lock
Value:
<thread.lock object at 0x3b120>                                        

_pfilter

Type:
PFilter
Value:
<paramiko.util.PFilter object at 0x289750>                             

Generated by Epydoc 2.1 on Wed May 10 18:42:05 2006 http://epydoc.sf.net