Small doc bug fixes

pull/49/head
Dan Puttick 2017-02-07 21:18:40 -05:00
parent 66dee077ce
commit 5a811438f2
6 changed files with 17 additions and 20 deletions

View File

@ -1,4 +1,4 @@
Version 2.1 - 2017-02-XX Version 2.1 - 2017-02-02
- Updated to the newest version of Raspbian Jessie lite (January 11th 2017 release) - Updated to the newest version of Raspbian Jessie lite (January 11th 2017 release)
- NTFS files can now be mounted as source or destination keys - NTFS files can now be mounted as source or destination keys
- Added udev rules that ensure the USB ports map deterministically to source and destination keys - Added udev rules that ensure the USB ports map deterministically to source and destination keys

View File

@ -4,8 +4,7 @@ Getting started
If you'd like to work on the Python code that processes files for Circlean, you should If you'd like to work on the Python code that processes files for Circlean, you should
take a look at [PyCIRCLean](https://github.com/CIRCL/PyCIRCLean), specifically the take a look at [PyCIRCLean](https://github.com/CIRCL/PyCIRCLean), specifically the
filecheck.py script. To get started contributing to Circlean, first, fork the project and filecheck.py script. To get started contributing to Circlean, first, fork the project and
`git clone` your fork. Then, follow the instructions in [setup_with_proot.md](doc/ `git clone` your fork. Then, follow the instructions in [setup_with_proot.md](doc/setup_with_proot.md) to build an image. To make things easier, you can also download a
setup_with_proot.md) to build an image. To make things easier, you can also download a
prebuilt image as mentioned in the README, and then mount and make modifications to this prebuilt image as mentioned in the README, and then mount and make modifications to this
image to test your changes. image to test your changes.
@ -25,8 +24,7 @@ Dependencies
* Pmount and ntfs-3g for mounting usb key partitions * Pmount and ntfs-3g for mounting usb key partitions
* Python 3 and pip for installing and running Python dependencies * Python 3 and pip for installing and running Python dependencies
* Python3-lxml for handling ooxml and other Office files in filecheck.py * Python3-lxml for handling ooxml and other Office files in filecheck.py
* libjpeg-dev libtiff-dev libwebp-dev liblcms2-dev tcl-dev for various image formats ( * libjpeg-dev, libtiff-dev, libwebp-dev, liblcms2-dev, tcl-dev, tk-dev, and python-tk for various image formats (dependencies for pillow)
dependencies for pillow)
* Exifread for file metadata * Exifread for file metadata
* Pillow for handling images * Pillow for handling images
* Olefile, oletools, and officedissector for handling various Office filetypes * Olefile, oletools, and officedissector for handling various Office filetypes

View File

@ -8,15 +8,14 @@ How To Install
[Graphical how-to and pre-built image download](http://circl.lu/projects/CIRCLean/). [Graphical how-to and pre-built image download](http://circl.lu/projects/CIRCLean/).
To prepare the SD card on Windows, you can use [Win32DiskImager](http://sourceforge.net/ To prepare the SD card on Windows, you can use [Win32DiskImager](http://sourceforge.net/projects/win32diskimager/). On linux/macOS, use dd (see the how-to link for
projects/win32diskimager/). On linux/macOS, use dd (see the how-to link for
instructions). instructions).
The current prebuilt image is based on the 1-11-17 release of Raspbian Jessie Lite. The current prebuilt image is based on the 1-11-17 release of Raspbian Jessie Lite.
The smallest SD card that Circlean can fit on is currently 4GB. The smallest SD card that Circlean can fit on is currently 4GB.
If you'd like to contribute to the project or build the image yourself, see If you'd like to contribute to the project or build the image yourself, see
[contributing](CONTRIBUTING.md) and the [setup instructions](doc/setup_with_proot.md). [contributing.md](CONTRIBUTING.md) and the [setup instructions](doc/setup_with_proot.md).
This is a work in progress - contributions are welcome. This is a work in progress - contributions are welcome.
Why/What Why/What
@ -26,7 +25,7 @@ This project aims to be useful when you get/find a USB key that you can't trust,
and you want to look at its contents without taking the risk of plugging it into and you want to look at its contents without taking the risk of plugging it into
your computer directly. The official project page can be found at [https://www.circl.lu/projects/CIRCLean/] your computer directly. The official project page can be found at [https://www.circl.lu/projects/CIRCLean/]
The Raspberry Pi Foundation blog has a [post](https://www.raspberrypi.org/blog/kittengroomercirclean-data-security-for-journalists-and-activists/) with more information The Raspberry Pi Foundation has a [blog post](https://www.raspberrypi.org/blog/kittengroomercirclean-data-security-for-journalists-and-activists/) with more information
about an older version of the project and details of the inspiration behind it. about an older version of the project and details of the inspiration behind it.
CIRCLean is currently tested to work with USB keys that have FAT32, NTFS, or CIRCLean is currently tested to work with USB keys that have FAT32, NTFS, or
@ -35,14 +34,14 @@ keys). Currently, exFAT is not supported due to lack of support for this format
The vast majority of USB keys will be FAT32 or NTFS. The vast majority of USB keys will be FAT32 or NTFS.
The content of the untrusted key will be copied or/and converted to the second The content of the untrusted key will be copied or/and converted to the second
(blank) key following these rules (based on the mime type as determined bylibmagic): (blank) key following these rules (based on the mime type as determined by libmagic):
- Direct copy of: - Direct copy of:
- Plain text files (mime type: text/*) - Plain text files (mime type: text/*)
- Audio files (mime type: audio/*) - Audio files (mime type: audio/*)
- Video files (mime type: video/*) - Video files (mime type: video/*)
- Example files (mime type: example/*) - Example files (mime type: example/*)
- Multipart files (mime type: multipart/*) - Multipart files (mime type: multipart/*)
- *xml* files, after being converted to text files - xml files, after being converted to text files
- Octet-stream files - Octet-stream files
- Copied after verification: - Copied after verification:
- Image files after verifying that they are not compression bombs (mime type: image/*) - Image files after verifying that they are not compression bombs (mime type: image/*)
@ -62,7 +61,7 @@ Usage
===== =====
0. Power off the device and unplug all connections. 0. Power off the device and unplug all connections.
1. Plug the untrusted key in the top USB slot of the Raspberry Pi. 1. Plug the untrusted key in the top left USB slot of the Raspberry Pi.
2. Plug your own key in the bottom USB slot (or use any of the other slots if 2. Plug your own key in the bottom USB slot (or use any of the other slots if
there are more than 2). there are more than 2).

View File

@ -19,7 +19,7 @@
- pmount ntfs-3g - pmount ntfs-3g
- python3 python3-pip - python3 python3-pip
- python3-lxml - python3-lxml
- libjpeg-dev libtiff-dev libwebp-dev liblcms2-dev tcl-dev - libjpeg-dev libtiff-dev libwebp-dev liblcms2-dev tcl-dev tk-dev python-tk
* Compile p7zip-rar from source * Compile p7zip-rar from source
- Change your source.list file - Change your source.list file
- Make a new directory and cd to it - Make a new directory and cd to it

View File

@ -37,7 +37,7 @@ Traceback of the qemu failure on digitalocean
pulseaudio: pa_context_connect() failed pulseaudio: pa_context_connect() failed
pulseaudio: Reason: Connection refused pulseaudio: Reason: Connection refused
pulseaudio: Failed to initialize PA contextaudio: Could not init `pa' audio driver pulseaudio: Failed to initialize PA contextaudio: Could not init 'pa' audio driver
ALSA lib confmisc.c:768:(parse_card) cannot find card '0' ALSA lib confmisc.c:768:(parse_card) cannot find card '0'
ALSA lib conf.c:4259:(_snd_config_evaluate) function snd_func_card_driver returned error: No such file or directory ALSA lib conf.c:4259:(_snd_config_evaluate) function snd_func_card_driver returned error: No such file or directory
ALSA lib confmisc.c:392:(snd_func_concat) error evaluating strings ALSA lib confmisc.c:392:(snd_func_concat) error evaluating strings
@ -47,7 +47,7 @@ ALSA lib conf.c:4259:(_snd_config_evaluate) function snd_func_refer returned err
ALSA lib conf.c:4738:(snd_config_expand) Evaluate error: No such file or directory ALSA lib conf.c:4738:(snd_config_expand) Evaluate error: No such file or directory
ALSA lib pcm.c:2239:(snd_pcm_open_noupdate) Unknown PCM default ALSA lib pcm.c:2239:(snd_pcm_open_noupdate) Unknown PCM default
alsa: Could not initialize DAC alsa: Could not initialize DAC
alsa: Failed to open `default': alsa: Failed to open 'default':
alsa: Reason: No such file or directory alsa: Reason: No such file or directory
ALSA lib confmisc.c:768:(parse_card) cannot find card '0' ALSA lib confmisc.c:768:(parse_card) cannot find card '0'
ALSA lib conf.c:4259:(_snd_config_evaluate) function snd_func_card_driver returned error: No such file or directory ALSA lib conf.c:4259:(_snd_config_evaluate) function snd_func_card_driver returned error: No such file or directory
@ -58,9 +58,9 @@ ALSA lib conf.c:4259:(_snd_config_evaluate) function snd_func_refer returned err
ALSA lib conf.c:4738:(snd_config_expand) Evaluate error: No such file or directory ALSA lib conf.c:4738:(snd_config_expand) Evaluate error: No such file or directory
ALSA lib pcm.c:2239:(snd_pcm_open_noupdate) Unknown PCM default ALSA lib pcm.c:2239:(snd_pcm_open_noupdate) Unknown PCM default
alsa: Could not initialize DAC alsa: Could not initialize DAC
alsa: Failed to open `default': alsa: Failed to open 'default':
alsa: Reason: No such file or directory alsa: Reason: No such file or directory
audio: Failed to create voice `lm4549.out' audio: Failed to create voice 'lm4549.out'
Could not initialize SDL(No available video device) - exiting Could not initialize SDL(No available video device) - exiting

View File

@ -2,7 +2,7 @@ Building the image from scratch
=============================== ===============================
There is always a prebuilt image available for download and installation as There is always a prebuilt image available for download and installation as
described in the [README](README.md). If you'd like to build the project yourself, described in the [README](../README.md). If you'd like to build the project yourself,
there are several steps involved: there are several steps involved:
* Downloading a generic Raspbian Lite image * Downloading a generic Raspbian Lite image
@ -146,7 +146,7 @@ raspbian-sys-mods related installs may fail - you can ignore them:
``` ```
* Install the linux dependencies (see CONTRIBUTING.md for more details): * Install the linux dependencies (see CONTRIBUTING.md for more details):
``` ```
apt-get install timidity git p7zip-full python3 python3-pip python3-lxml pmount ntfs-3g libjpeg-dev libtiff-dev libwebp-dev liblcms2-dev tcl-dev apt-get install timidity git p7zip-full python3 python3-pip python3-lxml pmount ntfs-3g libjpeg-dev libtiff-dev libwebp-dev tk-dev python-tk liblcms2-dev tcl-dev
``` ```
* Compile p7zip-rar from source. First, uncomment out the second line in /etc/apt/sources.list. Then: * Compile p7zip-rar from source. First, uncomment out the second line in /etc/apt/sources.list. Then:
``` ```
@ -161,7 +161,7 @@ have to edit your PATH variable or use pip3 to get the correct pip. You also mig
verify that these dependencies are current by checking in the PyCIRCLean git repo. verify that these dependencies are current by checking in the PyCIRCLean git repo.
``` ```
pip install -U pip pip install -U pip
pip install oletools exifread pillow pip install oletools exifread Pillow
pip install git+https://github.com/decalage2/oletools.git pip install git+https://github.com/decalage2/oletools.git
pip install git+https://github.com/Rafiot/officedissector.git pip install git+https://github.com/Rafiot/officedissector.git
pip install git+https://github.com/CIRCL/PyCIRCLean.git pip install git+https://github.com/CIRCL/PyCIRCLean.git