Skip to content

Commit

Permalink
Merge pull request #10 from philippwiesemann/fix-typos
Browse files Browse the repository at this point in the history
DOC: Fix typos
  • Loading branch information
jeremygray committed Jan 11, 2014
2 parents 545cb9b + a022be6 commit b2122d6
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions docs/source/index.rst
Expand Up @@ -110,15 +110,15 @@ Some considerations:
- OpenSSL is not distributed as part of the library (see Installation).
- By design, the computer used for encryption can be different from the computer used
for decryption; it can be a different device, operating system, and version of OpenSSL.
The only known incompatability that that signatures (obtained from ``sign()``)
The only known incompatibility is that signatures (obtained from ``sign()``)
can fail to ``verify()`` if the version of OpenSSL used is too different (i.e.,
if one is pre version 1.0 and the other is 1.0 or higher).
- You should both encrypt and decrypt only on machines that are physically secure,
with access limited to trusted people. Although encryption can be done anywhere,
using a public key, if someone used a different public key to encrypt data
intended for you, you would not be able to access "your" data.
- Ideally, do not move your private key from the machine on which it was
generated; certainly never ever email it. Its typically fine to share the public
generated; certainly never ever email it. It is typically fine to share the public
key, certainly within a small group of trusted people, such as a research lab.
The more widely it is distributed, the sooner it should be retired (and the
encryption rotated on files encrypted with that key).
Expand All @@ -136,7 +136,7 @@ Design goals:
reasons.
- For clarity, use and return full paths to files, not relative paths.
- Avoid obfuscation. It does
not enchance security, yet can make data recovery more difficult or expensive.
not enhance security, yet can make data recovery more difficult or expensive.
So transparency is preferred. For this reason, meta-data are generated by
default to make things less obscure; meta-data can be suppressed if desired.
- Require OpenSSL version is 0.9.8 or higher.
Expand All @@ -161,7 +161,7 @@ Dependencies
=================

pyFileSec requires (but does not itself package) a copy of OpenSSL and a secure
file-removal tool. Both are typically present on Mac and linux; if so,
file-removal tool. Both are typically present on Mac and Linux; if so,
installation is complete.

It is also possible to use a non-default (e.g., compiled) version of OpenSSL.
Expand All @@ -175,14 +175,14 @@ or using ``pyfilesec.set_openssl(path)`` (python).
% which srm
/usr/bin/srm

**On Linux**, its typically very similar::
**On Linux**, it is typically very similar::

% which openssl
/usr/bin/openssl
% which shred
/usr/bin/shred

**On Windows**, its also free but not as easy.
**On Windows**, it is also free but not as easy.

1. Download and install OpenSSL from http://slproweb.com/products/Win32OpenSSL.html.
First install the "Visual C++ 2008 Redistributables" (from the same page).
Expand All @@ -200,7 +200,7 @@ before being able to use them from pyFileSec.
Getting started
================

Generally, you do not need administrative privildges to work with pyFileSec once
Generally, you do not need administrative privileges to work with pyFileSec once
it is installed. (The only exception is that, on Windows, you need to be an admin
to check whether files have other hard links to them.)

Expand Down Expand Up @@ -232,7 +232,7 @@ Details about command-line syntax can be obtained using the usual ``--help`` opt

% python pyfilesec.py --help

.. note:: Any references to 'clear text' or 'plain text' simply mean an unencrypted file. It could be a binary file, or an encrypted file that is to be encrypted a second time. There is no requirement that it be text.
.. note:: Any references to 'clear text' or 'plain text' simply mean an unencrypted file. It could be a binary file, or an encrypted file that is to be encrypted a second time. There is no requirement that it must be text.

The main class of interest is SecFile, described next. Three other classes are used
internally, and so are also described here for completeness. There should be
Expand Down Expand Up @@ -299,7 +299,7 @@ noted).
version of ``sf.openssl``.

``hardlinks`` : count of all hardlinks to the file (int)
the count includes ``sf.file`` as one link. requires Admin priviledges on Windows.
the count includes ``sf.file`` as one link. requires Admin privileges on Windows.


class SecStr()
Expand Down Expand Up @@ -339,7 +339,7 @@ single underlying file on the file system. Currently this is an ordinary ``.tar.
x file.aes256.pwdrsa
x file.meta

The meta-data (``file.meta``) is always clear-text. This is to facillitate human
The meta-data (``file.meta``) is always clear-text. This is to facilitate human
inspection in archival uses.

.. autoclass:: pyfilesec.SecFileArchive
Expand Down Expand Up @@ -415,7 +415,7 @@ tested yet with machines known to be of different endian-ness, however.)
With one exception, the specific version of OpenSSL does not matter. The
known exception is that there are incompatibilities between v0.9.x and v1.0.x
when using sign / verify. Tested with 9 versions of openssl, running on Mac OS
X (10.8), 3 linux distributions, and Windows 7::
X (10.8), 3 Linux distributions, and Windows 7::

OpenSSL 0.9.8r 8 Feb 2011 Mac 10.8.3, python 2.7.3
OpenSSL 0.9.8x 10 May 2012 Mac 10.8.4, python 2.7.3
Expand Down Expand Up @@ -512,7 +512,7 @@ which is a crucial difference between the AES password and the RSA key pair.)
Q: What if I lose my private key?

A: Oops. **Fix:** None. The whole idea is that, if you don't have the private key,
data recovery should be prohibitively expensive, if its even possible (and it is
data recovery should be prohibitively expensive, if it is even possible (and it is
intended to not be possible). You should design your procedures under the
assumption that data recovery will not going to happen if you lose the private key,
even by hiring someone. (In fact, if someone can do so, please send me a private
Expand Down

0 comments on commit b2122d6

Please sign in to comment.