root/WizardsToolkit/trunk/www/command-line-tools.html

Revision 1, 9.7 KB (checked in by cristy, 3 months ago)


Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
4<head>
5  <style type="text/css"><!--
6    @import url("../www/wizard.css");
7  //--></style>
8  <title>Wizard's Toolkit: Command-line Tools</title>
9  <meta http-equiv="Content-Language" content="en-US"/>
10  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
11  <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
12  <meta name="Generator" content="PHP"/>
13  <meta name="Keywords" content="command-line, tools, WizardsToolkit, Wizard's, Toolkit"/>
14  <meta name="Description" content="The Wizard's Toolkit, version 1.0.2, is a free C API that includes a number of methods most developers will find useful in their projects."/>
15  <meta name="Rating" content="INDEX, FOLLOW"/>
16  <meta name="Robots" content="ALL"/>
17  <meta name="Generator" content="ImageMagick Studio LLC"/>
18  <meta name="Author" content="ImageMagick Studio LLC"/>
19  <meta name="Revisit-after" content="2 DAYS"/>
20  <meta name="Resource-type" content="document"/>
21  <meta name="Copyright" content="Copyright (c) 1999-2009 ImageMagick Studio LLC"/>
22  <meta name="Distribution" content="Global"/>
23  <link rel="shortcut icon" href="../images/wand.ico"  type="images/vnd.microsoft.icon"/>
24</head>
25
26<body id="www-wizards-toolkit.org">
27  <table id="titlebar" style="width: 100%;background-color: #f5f5f5" cellpadding="0" cellspacing="0" border="0" summary="Wizard's Toolkit">
28    <tbody>
29      <tr valign="top">
30        <td align="left"><a href="../index.html"><img id="titlebar-west" src="../images/script.png" alt="[Wizard's Toolkit]" width="400" height="60" border="0" vspace="28" name="titlebar-west" /></a></td>
31        <td align="left"><a href="http://www.wizards-toolkit.org/" target="744594348"><img id="titlebar-west" src="../images/sponsor.jpg" alt="[sponsor]" border="0" vspace="28" name="titlebar-west" /></a></td>
32        <td width="99%"><br /></td>
33        <td style="background-color: white" align="right"><a href="../index.html"><img src="../images/sprite.jpg" alt="" width="114" height="118" border="0" name="titlebar-east" /></a></td>
34        <td style="background-color: white" align="right"><a href="http://www.wizards-toolkit.org/discourse-server/viewforum.html?f=17" target="1836640887"><img id="titlebar-east" src="../images/logo.jpg" alt="" width="114" height="118" border="0" name="titlebar-east" /></a></td>
35      </tr>
36    </tbody>
37  </table>
38
39  <table style="width: 100%" border="0" cellpadding="0" cellspacing="0" summary="">
40  <tbody>
41
42    <tr valign="top" style="height: 100%;">
43      <td id="menu" width="1%" height="100%">
44      <p><a href="#main">Skip to page contents</a></p>
45       <font size="-1">
46      <span>[</span>
47      <a href="../index.html">About the<br />Wizard's Toolkit</a>
48  <span>]</span><br /><span>[</span>
49      <a href="../www/command-line-tools.html">Command-line Tools</a>
50  <span>]</span><br /><span>[</span>
51      <a href="../www/api.html">Application Program<br />Interface</a>
52  <span>]</span><br /><span>[</span>
53      <a href="../www/install-source.html">Install from Source</a>
54      <a href="../www/install-source.html#unix" class="sub">Unix</a>
55      <a href="../www/install-source.html#windows" class="sub">Windows</a>
56      <a href="../www/binary-releases.html">Binary Releases</a>
57      <a href="../www/binary-releases.html#unix" class="sub">Unix</a>
58      <a href="../www/binary-releases.html#windows" class="sub">Windows</a>
59  <span>]</span><br /><span>[</span>
60      <a href="../www/download.html">Download</a>
61  <span>]</span><br /><span>[</span>
62      <a href="../www/sponsors.html">Sponsors:</a>
63      <fieldset>
64  <a href="http://www.anxietyspinnerrings.com" class="sponsor" target="sponsor">Silver Rings</a><!-- 200904010140 -->
65<br />
66      </fieldset>
67      <span>]</span>
68      </font>
69      </td>
70
71      <td id="main" valign="top">
72<p class="navigation-index">[<a href="#encipher">encipher</a> &bull; <a href="#decipher">decipher</a> &bull; <a href="#cipher-info">cipher-info</a> &bull; <a href="#keyring">keyring</a> &bull; <a href="#digest">digest</a>]</p>
73
74<p>The Wizard's Toolkit includes a number of command-line utilities for encrypting, identifying, or decrypting files.</p>
75
76<p>The The Wizard's Toolkit command-line tools exit with a status of 0 if the command line arguments have a proper syntax and no problems are encountered.  Expect a descriptive message and an exit status of 1 if any exception occurs such as improper syntax, a problem reading or writing an file, or any other problem that prevents the command from completing successfully.</p>
77
78<p>In the paragraphs below, find a short description for each command-line tool. Click on the program name to get details about the program usage and a list of command-line options that alters how the program behaves.  If you are just getting acquainted with The Wizard's Toolkit, start with the <a href="#encipher">encipher</a> program.</p>
79
80<div style="margin: auto;">
81  <h2><a name="cipher"></a><a href="../www/encipher.html">encipher</a></h2>
82</div>
83
84<p>convert plaintext to ciphertext.</p>
85
86<div style="margin: auto;">
87  <h2><a name="cipher"></a><a href="../www/decipher.html">decipher</a></h2>
88</div>
89
90<p>convert ciphertext to plaintext.</p>
91
92<div style="margin: auto;">
93  <h2><a name="cipher-info"></a><a href="../www/cipher-info.html">cipher-info</a></h2>
94</div>
95
96<p>describe the format and characteristics of one or more encrypted files.</p>
97
98<div style="margin: auto;">
99  <h2><a name="keyring"></a><a href="../www/keyring.html">keyring</a></h2>
100</div>
101
102<p>Import, export, or list properties of keys on your keyring.</p>
103
104<div style="margin: auto;">
105  <h2><a name="cipher-info"></a><a href="../www/digest.html">digest</a></h2>
106</div>
107
108<p>return a message digest for one or more files or read message digests from a file and authenticate them.</p>
109
110<p>To get you started, here is a brief example of how you might use these utilities:</p>
111
112<pre class="text">
113  -> encipher -keyring keyring.xdm secret-message.txt secret-message.cip
114  Enter the passphrase (maximum of 4096 characters)
115  Enter passphrase:
116  Enter same passphrase again:
117 
118  -> cipher-info secret-message.cip
119  Filename: secret-message.cip
120    Cipher:
121      type: AES
122      mode: CTR
123      nonce: 61ae70a6a47793b40000000000000000
124    Authenticate:
125      method: Secret
126    Key:
127      hash: SHA256
128      length: 512
129      id: d596e432a92b2e60c76c104958d16dbe8a67519001249b69b46bfade54e6ac8c
130    Entropy Generator:
131      type: BZip
132      level: 6
133    Keyed-Hashed Message Authentication Code:
134      hash: SHA256
135    Random Generator:
136      hash: SHA256
137    Chunksize: 256kb
138    Dates:
139      modify: 2009-02-29T10:39:18-05:00
140      create: 2009-02-29T10:39:18-05:00
141      timestamp: 2009-02-29T10:41:48-05:00
142    Protocol: 1.0
143    Version: WizardsToolkit 1.0.5 02/29/08 http://www.wizards-toolkit.org
144 
145  -> keyring keyring.xdm -
146  &lt;?xml version="1.0"?>
147  &lt;rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
148           xmlns:keyring="http://www.wizards-toolkit.org/keyring/1.0/">
149    &lt;keyring:Keyring rdf:about="keyring.xdm">
150      &lt;keyring:modify-date>2009-02-29T10:41:48-05:00&lt;/keyring:modify-date>
151      &lt;keyring:create-date>2009-02-29T10:41:48-05:00&lt;/keyring:create-date>
152      &lt;keyring:timestamp>2009-02-29T10:41:48-05:00&lt;/keyring:timestamp>
153    &lt;/keyring:Keyring>
154    &lt;keyring:Key rdf:about="d596e432a92b2e60c76c104958d16dbe8a67519001249b69b46bfade54e6ac8c">
155      &lt;keyring:memberOf rdf:resource="keyring.xdm"/>
156      &lt;keyring:nonce>1d443b7e02ae82040000000000000000&lt;/keyring:nonce>
157      &lt;keyring:timestamp>2009-02-29T10:41:48-05:00&lt;/keyring:timestamp>
158      &lt;keyring:protocol>1.1&lt;/keyring:protocol>
159    &lt;/keyring:Key>
160  &lt;/rdf:RDF>
161 
162  -> decipher -keyring keyring.xdm secret-message.cip public-message.txt
163  Enter the passphrase (maximum of 4096 characters)
164  Enter passphrase:
165  Enter same passphrase again:
166 
167  -> digest secret-message.txt public-message.txt -
168  &lt;?xml version="1.0"?>
169  &lt;rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
170           xmlns:digest="http://www.wizards-toolkit.org/digest/1.0/">
171    &lt;digest:Content rdf:about="secret-message.txt">
172      &lt;digest:timestamp>2009-02-29T10:42:03-05:00&lt;/digest:timestamp>
173      &lt;digest:modify-date>2009-02-29T10:39:18-05:00&lt;/digest:modify-date>
174      &lt;digest:create-date>2009-02-29T10:39:18-05:00&lt;/digest:create-date>
175      &lt;digest:extent>9113&lt;/digest:extent>
176      &lt;digest:sha256>90ca62d8a67e43f86b67162e6a5804612e2c45d44a014760c49e1999b9fb344e&lt;/digest:sha256>
177    &lt;/digest:Content>
178    &lt;digest:Content rdf:about="public-message.txt">
179      &lt;digest:timestamp>2009-02-29T10:42:03-05:00&lt;/digest:timestamp>
180      &lt;digest:modify-date>2009-02-29T10:39:18-05:00&lt;/digest:modify-date>
181      &lt;digest:create-date>2009-02-29T10:39:18-05:00&lt;/digest:create-date>
182      &lt;digest:extent>8196&lt;/digest:extent>
183      &lt;digest:sha256>90ca62d8a67e43f86b67162e6a5804612e2c45d44a014760c49e1999b9fb344e&lt;/digest:sha256>
184    &lt;/digest:Content>
185  &lt;/rdf:RDF>
186</pre>
187
188      </td>
189      <td id="margin" width="1%" height="100%" valign="top" align="right">&nbsp;</td>
190    </tr>
191  </tbody>
192  </table>
193  <div id="linkbar">
194    <a href="http://www.wizards-toolkit.org/discourse-server/viewforum.html?f=17" target="793800654">Discourse Server</a> |
195    <a href="../www/license.html">License</a> |
196    <a href="../www/notice.html">Notice</a>
197  </div>
198  <div id="footer">
199    <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>
200  </div>
201  <div style="clear: both; margin: 0; width: 100%; "></div>
202</body>
203</html>
Note: See TracBrowser for help on using the browser.