<!DOCTYPE html PUBLIC
"-//W3C//DTD HTML 4.0 Transitional//EN">
<link rel=
"STYLESHEET" href=
"lib.css" type='text/css'
/>
<link rel=
"SHORTCUT ICON" href=
"../icons/pyfav.png" type=
"image/png" />
<link rel='start' href='../index.html' title='Python Documentation Index'
/>
<link rel=
"first" href=
"lib.html" title='Python Library Reference'
/>
<link rel='contents' href='contents.html'
title=
"Contents" />
<link rel='index' href='genindex.html' title='Index'
/>
<link rel='last' href='about.html' title='About this document...'
/>
<link rel='help' href='about.html' title='About this document...'
/>
<link rel=
"prev" href=
"module-md5.html" />
<link rel=
"parent" href=
"crypto.html" />
<link rel=
"next" href=
"tkinter.html" />
<meta name='aesop' content='information'
/>
<title>15.3 sha -- SHA-
1 message digest algorithm
</title>
<div id='top-navigation-panel' xml:id='top-navigation-panel'
>
<table align=
"center" width=
"100%" cellpadding=
"0" cellspacing=
"2">
<td class='online-navigation'
><a rel=
"prev" title=
"15.2 md5 "
href=
"module-md5.html"><img src='../icons/previous.png'
border='
0' height='
32' alt='Previous Page' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"parent" title=
"15. Cryptographic Services"
href=
"crypto.html"><img src='../icons/up.png'
border='
0' height='
32' alt='Up One Level' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"next" title=
"16. Graphical User Interfaces"
href=
"tkinter.html"><img src='../icons/next.png'
border='
0' height='
32' alt='Next Page' width='
32'
/></A></td>
<td align=
"center" width=
"100%">Python Library Reference
</td>
<td class='online-navigation'
><a rel=
"contents" title=
"Table of Contents"
href=
"contents.html"><img src='../icons/contents.png'
border='
0' height='
32' alt='Contents' width='
32'
/></A></td>
<td class='online-navigation'
><a href=
"modindex.html" title=
"Module Index"><img src='../icons/modules.png'
border='
0' height='
32' alt='Module Index' width='
32'
/></a></td>
<td class='online-navigation'
><a rel=
"index" title=
"Index"
href=
"genindex.html"><img src='../icons/index.png'
border='
0' height='
32' alt='Index' width='
32'
/></A></td>
<div class='online-navigation'
>
<b class=
"navlabel">Previous:
</b>
<a class=
"sectref" rel=
"prev" href=
"module-md5.html">15.2 md5
</A>
<b class=
"navlabel">Up:
</b>
<a class=
"sectref" rel=
"parent" href=
"crypto.html">15. Cryptographic Services
</A>
<b class=
"navlabel">Next:
</b>
<a class=
"sectref" rel=
"next" href=
"tkinter.html">16. Graphical User Interfaces
</A>
<!--End of Navigation Panel-->
<H1><A NAME=
"SECTION0017300000000000000000">
15.3 <tt class=
"module">sha
</tt> --
SHA-
1 message digest algorithm
</A>
<A NAME=
"module-sha"></A>
This module implements the interface to NIST's
<a id='l2h-
4830' xml:id='l2h-
4830'
></a> secure hash
algorithm,
<a id='l2h-
4831' xml:id='l2h-
4831'
></a> known as SHA-
1. SHA-
1 is an
improved version of the original SHA hash algorithm. It is used in
the same way as the
<tt class=
"module"><a href=
"module-md5.html">md5
</a></tt> module: use
<tt class=
"function">new()
</tt>
to create an sha object, then feed this object with arbitrary strings
using the
<tt class=
"method">update()
</tt> method, and at any point you can ask it
for the
<i class=
"dfn">digest
</i> of the concatenation of the strings fed to it
so far.
<a id='l2h-
4832' xml:id='l2h-
4832'
></a> SHA-
1 digests are
160 bits instead of
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
4823' xml:id='l2h-
4823'
class=
"function">new
</tt></b>(
</nobr></td>
<td><var></var><big>[
</big><var>string
</var><big>]
</big><var></var>)
</td></tr></table></dt>
Return a new sha object. If
<var>string
</var> is present, the method
call
<code>update(
<var>string
</var>)
</code> is made.
The following values are provided as constants in the module and as
attributes of the sha objects returned by
<tt class=
"function">new()
</tt>:
<dl><dt><b><tt id='l2h-
4824' xml:id='l2h-
4824'
>blocksize
</tt></b></dt>
Size of the blocks fed into the hash function; this is always
<code>1</code>. This size is used to allow an arbitrary string to be
<dl><dt><b><tt id='l2h-
4825' xml:id='l2h-
4825'
>digest_size
</tt></b></dt>
The size of the resulting digest in bytes. This is always
An sha object has the same methods as md5 objects:
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
4826' xml:id='l2h-
4826'
class=
"method">update
</tt></b>(
</nobr></td>
<td><var>arg
</var>)
</td></tr></table></dt>
Update the sha object with the string
<var>arg
</var>. Repeated calls are
equivalent to a single call with the concatenation of all the
arguments:
<code>m.update(a); m.update(b)
</code> is equivalent to
<code>m.update(a+b)
</code>.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
4827' xml:id='l2h-
4827'
class=
"method">digest
</tt></b>(
</nobr></td>
<td><var></var>)
</td></tr></table></dt>
Return the digest of the strings passed to the
<tt class=
"method">update()
</tt>
method so far. This is a
20-byte string which may contain
non-ASCII characters, including null bytes.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
4828' xml:id='l2h-
4828'
class=
"method">hexdigest
</tt></b>(
</nobr></td>
<td><var></var>)
</td></tr></table></dt>
Like
<tt class=
"method">digest()
</tt> except the digest is returned as a string of
length
40, containing only hexadecimal digits. This may
be used to exchange the value safely in email or other non-binary
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
4829' xml:id='l2h-
4829'
class=
"method">copy
</tt></b>(
</nobr></td>
<td><var></var>)
</td></tr></table></dt>
Return a copy (``clone'') of the sha object. This can be used to
efficiently compute the digests of strings that share a common initial
<p class=
"heading">See Also:
</p>
<dl compact=
"compact" class=
"seetitle">
<dt><em class=
"citetitle"><a href=
"http://csrc.nist.gov/publications/fips/fips180-2/fips180-2withchangenotice.pdf"
>Secure Hash Standard
</a></em></dt>
<dd>The Secure Hash Algorithm is defined by NIST document FIPS
href=
"http://csrc.nist.gov/publications/fips/fips180-2/fips180-2withchangenotice.pdf"
title=
"Secure Hash Standard"
>Secure Hash Standard
</a></em>, published in August
2002.
</dd>
<dl compact=
"compact" class=
"seetitle">
<dt><em class=
"citetitle"><a href=
"http://csrc.nist.gov/encryption/tkhash.html"
>Cryptographic Toolkit (Secure Hashing)
</a></em></dt>
<dd>Links from NIST to various information on secure hashing.
</dd>
<div class='online-navigation'
>
<table align=
"center" width=
"100%" cellpadding=
"0" cellspacing=
"2">
<td class='online-navigation'
><a rel=
"prev" title=
"15.2 md5 "
href=
"module-md5.html"><img src='../icons/previous.png'
border='
0' height='
32' alt='Previous Page' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"parent" title=
"15. Cryptographic Services"
href=
"crypto.html"><img src='../icons/up.png'
border='
0' height='
32' alt='Up One Level' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"next" title=
"16. Graphical User Interfaces"
href=
"tkinter.html"><img src='../icons/next.png'
border='
0' height='
32' alt='Next Page' width='
32'
/></A></td>
<td align=
"center" width=
"100%">Python Library Reference
</td>
<td class='online-navigation'
><a rel=
"contents" title=
"Table of Contents"
href=
"contents.html"><img src='../icons/contents.png'
border='
0' height='
32' alt='Contents' width='
32'
/></A></td>
<td class='online-navigation'
><a href=
"modindex.html" title=
"Module Index"><img src='../icons/modules.png'
border='
0' height='
32' alt='Module Index' width='
32'
/></a></td>
<td class='online-navigation'
><a rel=
"index" title=
"Index"
href=
"genindex.html"><img src='../icons/index.png'
border='
0' height='
32' alt='Index' width='
32'
/></A></td>
<div class='online-navigation'
>
<b class=
"navlabel">Previous:
</b>
<a class=
"sectref" rel=
"prev" href=
"module-md5.html">15.2 md5
</A>
<b class=
"navlabel">Up:
</b>
<a class=
"sectref" rel=
"parent" href=
"crypto.html">15. Cryptographic Services
</A>
<b class=
"navlabel">Next:
</b>
<a class=
"sectref" rel=
"next" href=
"tkinter.html">16. Graphical User Interfaces
</A>
<span class=
"release-info">Release
2.4.2, documentation updated on
28 September
2005.
</span>
<!--End of Navigation Panel-->
See
<i><a href=
"about.html">About this document...
</a></i> for information on suggesting changes.