| Yingdi Yu | 4e99f53 | 2014-08-25 19:40:57 -0700 | [diff] [blame] | 1 | client.conf |
| 2 | =========== |
| 3 | |
| 4 | System configuration of NDN platform is specified in ``client.conf``. |
| 5 | Here is an example of ``client.conf`` for current ndn-cxx package: |
| 6 | |
| 7 | :: |
| 8 | |
| 9 | ; "unix_socket" specifies the location of the NFD unix socket |
| 10 | unix_socket=/var/run/nfd.sock |
| 11 | |
| 12 | ; "protocol" determines the protocol for prefix registration |
| 13 | ; it has a value of: |
| 14 | ; nrd-0.1 |
| 15 | protocol=nrd-0.1 |
| 16 | |
| 17 | ; "pib" determines which Public Info Base (PIB) should used by default in applications. |
| 18 | ; If "pib" is not specified, the default PIB will be used. |
| 19 | ; Note that default PIB could be different on different system. |
| 20 | ; If "pib" is specified, it may have a value of: |
| 21 | ; sqlite3 |
| 22 | ; pib=sqlite3 |
| 23 | |
| 24 | ; "tpm" determines which Trusted Platform Module (TPM) should used by default in applications. |
| 25 | ; If "tpm" is not specified, the default TPM will be used. |
| 26 | ; Note that default TPM could be different on different system. |
| 27 | ; If "tpm" is specified, it may have a value of: |
| 28 | ; file |
| 29 | ; osx-keychain |
| 30 | ; tpm=file |
| 31 | |
| 32 | NFD |
| 33 | --- |
| 34 | |
| 35 | unix_socket |
| 36 | The local interface of NFD to applications. By default, the path to the socket is ``/var/run/nfd.sock``. |
| 37 | |
| 38 | Prefix Registration |
| 39 | ------------------- |
| 40 | |
| 41 | protocol |
| 42 | The prefix registration protocol. For now, only one protocol ``nrd-0.1`` is supported. |
| 43 | With this protocol, applications send prefix registration requests to NRD. |
| 44 | NRD, after authenticating the request, will set up corresponding FIB entries in NFD. |
| 45 | |
| 46 | Key Management |
| 47 | -------------- |
| 48 | |
| 49 | tpm |
| 50 | Trusted Platform Module (TPM) where the private keys are stored. |
| 51 | Two options are currently available: ``file`` and ``osx-keychain``. |
| 52 | **Users are not supposed to change the ``tpm`` setting once it is configued, |
| 53 | otherwise users may face the problem of "Keys are not found".** |
| 54 | The default value of ``tpm`` depends on the operating system. |
| 55 | For OS X, the default value is ``osx-keychain``. |
| 56 | For other systems, the default value is ``file``. |
| 57 | |
| 58 | pib |
| 59 | The public key information for each private key stored in TPM. |
| 60 | There is only one option for ``pib``: ``sqlite3``, which is also the default value of ``pib``. |
| 61 | |
| 62 | Users are not supposed to change the configuration of Key Management. |
| 63 | If changes is inevitable, please clean up the all the existing data (which is usually under ``~/.ndn/``): |
| 64 | |
| 65 | :: |
| 66 | |
| 67 | rm -rf ~/.ndn/ndnsec-* |