X-Git-Url: http://git.tuebingen.mpg.de/?a=blobdiff_plain;f=web%2Fmanual.md;h=78834a4d48be70f178dba5ffed88f5db8761745c;hb=ccbe76ece6a8d05439b2dbb51c1c777735c4171e;hp=04c716a87da88b81ab43ef01f15c8067bef46ea3;hpb=f4019242252bf8e7594a72efdac6214a5abd4364;p=paraslash.git diff --git a/web/manual.md b/web/manual.md index 04c716a8..78834a4d 100644 --- a/web/manual.md +++ b/web/manual.md @@ -293,7 +293,7 @@ Requirements cd osl && make && sudo make install && sudo ldconfig sudo apt-get install autoconf libssl-dev m4 \ libmad0-dev libid3tag0-dev libasound2-dev libvorbis-dev \ - libfaad-dev libspeex-dev libFLAC-dev libsamplerate-dev realpath \ + libfaad-dev libspeex-dev libflac-dev libsamplerate-dev \ libasound2-dev libao-dev libreadline-dev libncurses-dev \ libopus-dev @@ -358,7 +358,7 @@ recognized. The mp3 tagger also needs this library for modifying you need libogg, libvorbis, libvorbisfile. The corresponding Debian packages are called `libogg-dev` and `libvorbis-dev`. -- [libfaad and mp4ff](http://www.audiocoding.com/). For aac files +- [libfaad and mp4ff](https://sourceforge.net/projects/faac/). For aac files (m4a) you need libfaad and libmp4ff (package: `libfaad-dev`). Note that for some distributions, e.g. Ubuntu, mp4ff is not part of the libfaad package. Install the faad library from sources (available @@ -446,7 +446,7 @@ following commands: Next, change to the "bar" account on client_host and generate the key pair with the commands - ssh-keygen -q -t rsa -b 2048 -N '' -f $key + ssh-keygen -q -t rsa -b 2048 -N '' -m RFC4716 This generates the two files id_rsa and id_rsa.pub in ~/.ssh. Note that para_server won't accept keys shorter than 2048 bits. Moreover, @@ -488,10 +488,10 @@ An empty database is created with para_client init This initializes a couple of empty tables under -~/.paraslash/afs_database-0.4. You normally don't need to look at these +~/.paraslash/afs_database-0.7. You normally don't need to look at these tables, but it's good to know that you can start from scratch with - rm -rf ~/.paraslash/afs_database-0.4 + rm -rf ~/.paraslash/afs_database-0.7 in case something went wrong. @@ -613,10 +613,11 @@ while the second part is the session key. - para_client receives the encrypted buffer and decrypts it with the user's private key, thereby obtaining the challenge buffer and the -session key. It sends the SHA1 hash value of the challenge back to -para_server and stores the session key for further use. +session key. It hashes the challenge buffer with a crytographic hash +function, sends the hash value back to para_server and stores the +session key for further use. -- para_server also computes the SHA1 hash of the challenge and compares +- para_server also computes the hash value of the challenge and compares it against what was sent back by the client. - If the two hashes do not match, the authentication has failed and @@ -630,7 +631,7 @@ the session key known to both peers. paraslash relies on the quality of the pseudo-random bytes provided by the crypto library (openssl or libgcrypt), on the security of the implementation of the RSA and AES crypto routines and on the -infeasibility to invert the SHA1 function. +infeasibility to invert the hash function. Neither para_server or para_client create RSA keys on their own. This has to be done once for each user as sketched in @@ -804,10 +805,11 @@ This is the most important and usually also the largest table of the AFS database. It contains the information needed to stream each audio file. In particular the following data is stored for each audio file. -- SHA1 hash value of the audio file contents. This is computed once -when the file is added to the database. Whenever AFS selects this -audio file for streaming the hash value is recomputed and checked -against the value stored in the database to detect content changes. +- The cryptographic hash value of the audio file contents. This is +computed once when the file is added to the database. Whenever AFS +selects this audio file for streaming the hash value is recomputed +and checked against the value stored in the database to detect +content changes. - The time when this audio file was last played. @@ -1023,6 +1025,7 @@ Keyword | Type | Semantic value `bitrate` | integer | The average bitrate `frequency` | integer | The output sample rate `channels` | integer | The number of channels +`duration` | integer | The number of milliseconds `is_set("foo")` | boolean | True if attribute "foo" is set. [\*] For most audio formats, the year tag is stored as a string. It @@ -1146,7 +1149,7 @@ if the "-a" switch is given: File renames and content changes -------------------------------- -Since the audio file selector knows the SHA1 of each audio file that +Since the audio file selector knows the hash of each audio file that has been added to the afs database, it recognizes if the content of a file has changed, e.g. because an ID3 tag was added or modified. Also, if a file has been renamed or moved to a different location, @@ -1175,14 +1178,14 @@ may refuse to start again because of "dirty osl tables". In this case you'll have to run the oslfsck program of libosl to fix your database: - oslfsck -fd ~/.paraslash/afs_database-0.4 + oslfsck -fd ~/.paraslash/afs_database-0.7 However, make sure para_server isn't running before executing oslfsck. If you don't mind to recreate your database you can start from scratch by removing the entire database directory, i.e. - rm -rf ~/.paraslash/afs_database-0.4 + rm -rf ~/.paraslash/afs_database-0.7 Be aware that this removes all attribute definitions, all playlists and all mood definitions and requires to re-initialize the tables. @@ -2074,11 +2077,11 @@ here are the most important points. - Don't leave whitespace at the end of lines. - The limit on the length of lines is 80 columns. - Use K&R style for placing braces and spaces: - +
 		if (x is true) {
 			we do y
 		}
-
+
- Use a space after (most) keywords. - Do not add spaces around (inside) parenthesized expressions. - Use one space around (on each side of) most binary and ternary operators.