mirror of
https://codeberg.org/scip/note.git
synced 2025-12-17 04:31:02 +01:00
CHANGED: removed install.sh. use now a Makefile for installation.
ADDED: Encryption support. Note can now encrypt notes using IDEA
or DES as encryption-protocols(symetric).
This commit is contained in:
102
README
102
README
@@ -1,4 +1,4 @@
|
||||
note 0.9 by Thomas Linden, 20/03/2000
|
||||
note 1.0.0 by Thomas Linden, 18/04/2000
|
||||
|
||||
|
||||
Introduction
|
||||
@@ -15,7 +15,8 @@ Introduction
|
||||
as you want. You can run note from the commandline
|
||||
or interactive from within your console. You can
|
||||
sort your notes in different topics, which is usefull
|
||||
if you have a lot of them.
|
||||
if you have a lot of them. Additional it is possible
|
||||
to encrypt your notes for protection.
|
||||
|
||||
There are currently two different database backends,
|
||||
which you can use with note:
|
||||
@@ -43,13 +44,24 @@ Requirements
|
||||
Installation
|
||||
============
|
||||
|
||||
There is a script provided called "install.sh", which will
|
||||
ask you a few questions about file destinations and database
|
||||
backends. Simply answer this questions and it does the rest.
|
||||
Unpack the tar-ball and issue the command:
|
||||
$ perl Makefile.PL
|
||||
It will ask you a few questions about file destinations.
|
||||
The script will find itself the proper destinations for
|
||||
the files. So, if you agree with it, simply press ENTER.
|
||||
However, you may decide to use other destinations. In this
|
||||
case, enter it, when asked. This maybe usefull, if you are
|
||||
installing it in your ome-directory and if you are not root!
|
||||
|
||||
For installation instructions for the mysql database installation
|
||||
see mysql/README.
|
||||
|
||||
If want to use another SQL database, i.e. postgresql then set
|
||||
the option "$DRIVER" to the name of the responding DBI-driver
|
||||
and create a symlink of this name like this:
|
||||
/usr/lib/perl5/siteperl/NOTEDB $ ln -s mysql.pm oracle.pm
|
||||
The functionality is the same, but not the name!
|
||||
|
||||
|
||||
|
||||
Configuration
|
||||
@@ -259,51 +271,49 @@ Format of the ASCII-dump file (note -D)
|
||||
Security
|
||||
========
|
||||
|
||||
You can't use the following hints with the mysql version!
|
||||
Refer to the mysql manual for more informations about
|
||||
security of mysql databases:
|
||||
If you are using the MySQL driver, refer to the mysql
|
||||
manual for more informations about security of mysql databases:
|
||||
http://www.mysql.org/Manual_chapter/manual_Privilege_system.html
|
||||
|
||||
If you want to protect the notedb against unauthorized persons
|
||||
(even root), you might want to use pgp. I use gpg (GNU privacy
|
||||
guard), which is compatible to pgp, usage should be similar.
|
||||
You could add a function to your .profile or .bashrc or whatever:
|
||||
--- snip ---
|
||||
function note
|
||||
{
|
||||
gpg -o ~/.notedb -d ~/.notedb.gpg
|
||||
note $1 $2 $3
|
||||
gpg -e ~/.notedb --yes -r username
|
||||
rm -rf ~/.notedb
|
||||
}
|
||||
--- snip ---
|
||||
You should replace <username> with your real username. After applying
|
||||
this function to your .profile, issue the following command:
|
||||
"source .profile"
|
||||
You shell will reread the file, so you can try it out without the need
|
||||
of new login.
|
||||
This function assumes, there exists a file called "~/.notedb.gpg",
|
||||
therefore you need to encrypt your notedb once before you can use this
|
||||
funcion:
|
||||
"gpg -e ~/.notedb --yes -r username"
|
||||
If you are using notes proprietary binary driver, then
|
||||
the permission 0600 of the file "~/.notedb" is strongly required!
|
||||
|
||||
Here is, how to do it with pgp, create a shell script with the following
|
||||
content:
|
||||
--- snip ---
|
||||
#!/bin/sh
|
||||
/bin/echo -n "passphrase:"
|
||||
pgp -o ~/.notedb -d ~/.notedb.pgp > /dev/null 2>&1
|
||||
rm -f ~/.notedb.pgp > /dev/null 2>&1
|
||||
note.pl $1 $2 $3
|
||||
pgp -e ~/.notedb tlinden > /dev/null 2>&1
|
||||
rm -f ~/.notedb > /dev/null 2>&1
|
||||
--- snip ---
|
||||
Do "chmod 700 whatevername". That's it.
|
||||
Additional, you can turn on encryption from the config file.
|
||||
Simply set $USE_CRYPT to "YES". Please note, that you need
|
||||
to decide, if you want to use encryption before the first use
|
||||
of note! If have already a note database and want to "migrate"
|
||||
to encryption, I suggest you to follow the directions in the
|
||||
file UPGRADE!
|
||||
|
||||
If you don't make use of encryption, I suggest you to chmod it:
|
||||
"chmod 600 .notedb"
|
||||
So, only you can read the file (and root or any intruder who became root).
|
||||
You can choose from different encryption algorythms. The default
|
||||
is IDEA, but DES or BLOWFISH is also possible. You need to have
|
||||
installed the following additional perl-modules on your system:
|
||||
MD5
|
||||
Crypt::IDEA
|
||||
Crypt::DES
|
||||
Crypt::CBC
|
||||
|
||||
After turning on encryption, note will ask you for a passphrase
|
||||
everytime it runs! It will *not* store this passphrase!
|
||||
So, don't forget it! Be careful!
|
||||
|
||||
Once note have encrypted some data using this passphrase, you
|
||||
cannot simply switch to another passphrase, because all data
|
||||
within the database needs to be encrypted using the same passphrase!
|
||||
If you want to change the passphrase for any reason, please read
|
||||
the file UPGRADE and follow it's directions!
|
||||
Someday I will add a "change passwd" function, which will do all
|
||||
these things for you. Someday, I said...
|
||||
|
||||
Note: To make sure, the encrypted data can be stored properly,
|
||||
it will be uuencoded after encryption.
|
||||
|
||||
Note: *If* you forgot your passphrase and *if* you don't have
|
||||
a backup of your database without encryption, PLEASE
|
||||
don't bother me with "helpme" emails! If you don't know
|
||||
the phrase, then the data can't be decrypted. Even if it
|
||||
is possible - I am not responsible for that!
|
||||
|
||||
|
||||
|
||||
Comments
|
||||
@@ -336,4 +346,4 @@ Author and Copyright
|
||||
Last changed
|
||||
============
|
||||
|
||||
19/03/2000
|
||||
18/04/2000
|
||||
|
||||
Reference in New Issue
Block a user