Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
Michael Geitz committed Dec 3, 2015
1 parent a1a5935 commit 769d15d
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ key encrypted LSB steganography PNG album filesystem in userspace

Create, access, and modify a key encrypted LSB steganography filesystem in userspace using a directory of PNG images. Filesystem state is only preserved after safely closing the filesystem via unmount or Ctrl+C. A filesystem may only use images with the same dimensions as the root image provided.

A filesystem requires a name, key, root image, and storage images. To access a filesystem the correct key, filesystem name, and root image must be given. All data is XOR'd with the sha512 hash of the key as it is read and written from the images. The root image stores the filesystem name, consumed and total space, image and file count, image hashs, and file meta data. All images added to the filesystem while formatting or expanding are found in the same directory as the root image.
A filesystem requires a name, key, root image, and storage images. To access a filesystem the correct key, filesystem name, and root image must be given. All data is XOR'd with the SHA512 hash of the key as it is read and written from the images. The root image stores the filesystem name, consumed and total space, image and file count, image hashs, and file meta data. All images added to the filesystem while formatting or expanding are found in the same directory as the root image.

Formatting a filesystem wipes each avialable least signifigant bit in the images provided, similarly removing a file wipes its data and shifts the filesystem if there is a hole. All files in the filesystem have permissions of 644 and cannot be edited, but can be read, renamed, deleted, and copied.

Expand Down
4 changes: 2 additions & 2 deletions albumfs.1
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
.\" Manpage for albumfs.
.TH ALBUMFS 1 "Dec 2015" "0.1.3" "User Commands"
.TH ALBUMFS 1 "Dec 2015" "0.1.4" "User Commands"
.SH NAME
albumfs \- key encrypted LSB steganography PNG album filesystem in userspace
.SH SYNOPSIS
albumfs [OPTIONS]... [PATH/TO/ROOTIMAGE.PNG]
.SH DESCRIPTION
Create, access, and modify a LSB steganography filesystem in userspace using a directory of PNG images. Filesystem state is only preserved after safely closing the filesystem via unmount or Ctrl+C. A filesystem may only use images with the same dimensions as the root image provided.
.PP
A filesystem requires a name, key, root image, and storage images. To access a filesystem the correct key, filesystem name, and root image must be given. All data is XOR'd with the key as it is read and written from the images. The root image stores the filesystem name, consumed and total space, image and file count, image filenames, and file meta data. All images added to the filesystem while formatting or expanding are found in the same directory as the root image.
A filesystem requires a name, key, root image, and storage images. To access a filesystem the correct key, filesystem name, and root image must be given. All data is XOR'd with SHA512 hash of the key as it is read and written from the images. The root image stores the filesystem name, consumed and total space, image and file count, image filenames, and file meta data. All images added to the filesystem while formatting or expanding are found in the same directory as the root image.
.PP
Formatting a filesystem wipes each avialable least signifigant bit in the images provided, similarly removing a file wipes its imprint and shifts the filesystem if there is a hole. All files in the filesystem have permissions of 644 and cannot be edited, but can be read, renamed, deleted, and copied.
.TP
Expand Down

0 comments on commit 769d15d

Please sign in to comment.