Contribute¶

• Contribute
• Generate your own ssh public key
• Unix
• Windows
• Send us your ssh public key
• Use your key with GIT
• Unix
• Windows
• Mapping configuration of your user
• Unix
• Windows

Digital Forensics Framework use GIT as source code manager. Access is freely available to everyone using adress :

git://git.digital-forensic.org/dff.git

But, in order to contribute, you have to send us your ssh public key.
If you already have a ssh public key, go to step Send us your ssh public key .

Generate your own ssh public key¶

Unix¶

Use ssh-keygen command to generate your 2048bits RSA private and public keys. Here is an example :

cma@chichodrome ~ $ ssh-keygen -t rsa
Generating public/private rsa key pair.
Enter file in which to save the key (/home/cma/.ssh/id_rsa): 
Enter passphrase (empty for no passphrase): 
Enter same passphrase again: 
Your identification has been saved in /home/cma/.ssh/id_rsa.
Your public key has been saved in /home/cma/.ssh/id_rsa.pub.
The key fingerprint is:
e8:f6:62:c8:f6:37:ea:6a:d0:b4:f0:18:82:53:e2:dd cma@chichodrome
The key's randomart image is:
+--[ RSA 2048]----+
[...]
+-----------------+
cma@chichodrome ~ $ ls -la ~/.ssh
[...]
-rw-------  1 cma users 1675 Jan 11 15:57 id_rsa
-rw-r--r--  1 cma users  401 Jan 11 15:57 id_rsa.pub
[...]

The ssh-keygen asks you where to store keys, it also asks you for a passphrase, it is not mandatory to submit a passphrase.
Once completed, you public keys is usually ~/.ssh/id_rsa.pub .

Windows¶

Use PuTTYgen, from Simon Tatham

Double-click on puttygen.exe, first step : click on "Generate" :

Move your mouse to generate entropy :

Wait before completion of the generation process :

Optionnaly add a passphrase to protect your key :

Final step : save both public and private keys in a protected location :

Send us your ssh public key¶

Depending on the generation method ;

• on Unix you have to send us ~/.ssh/id_rsa.pub
• on Windows where you save it at the final step

Send the text contained in this public key, or the entire file, to cma@digital-forensic.org also add the username you own on DFF wiki/bugtracker or the username you wish to use.

Use your key with GIT¶

The url to use to clone our repository is the same as the public version, but you have to pretend the git user :

git@git://git.digital-forensic.org/dff.git

Unix¶

On Linux / BSD ; your id_rsa and id_rsa.pub just have to sit in ~/.ssh/ to be used. Once your key have been validated just run this command to clone the repository in contributor mode :

git clone git@git://git.digital-forensic.org/dff.git

Windows¶

On Windows we recommend usage of TortoiseGIT + MSysGIT. With it you can easily add your .pub and .ppk generated with PuTTYgen. In fact we will only add the .ppk key because this .ppk is composed of both public and private key.

First step, right click in the blank area in the directory where you want to add DFF and select "Git clone..." :

Second step, add the URL git@git://git.digital-forensic.org/dff.git , check "Load Putty Key" and add the path where your private key (.ppk) is and click OK :

The fetching process start :

First time you connect to our repo, you will be warned this is a new repository, click "Yes" to add our repository to your trusted pool :

Final step : Fetching process done, click "Close" :

Mapping configuration of your user¶

Because user-name on your computer generally differs from the one used on DFF wiki/bugtracker/GIT, you have to set your user-name and e-mail up. If you don't do this, activity and statistics will not be mapped to your user-name.

Unix¶

On Unix this can be achieved by adding this three lines in the file ~/.gitconfig, here is an example for the user cma :

[user]
        name = cma
        email = cma@digital-forensic.org

Windows¶

Right click in a blank area, under ToitoiseGit select Settings :

On the left select Git, Config and add your User Info according to your account on DFF wiki/bugtracker, here is an example for the user cma :

Well done ! you are ready to contribute to DFF !