tarsnap-keyregen.1-mdoc 2.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778
  1. .\" Copyright 2011 Colin Percival
  2. .\" All rights reserved.
  3. .\"
  4. .Dd @DATE@
  5. .Dt TARSNAP-KEYREGEN 1
  6. .Os
  7. .Sh NAME
  8. .Nm tarsnap-keyregen
  9. .Nd generate a key file for use with
  10. .Xr tarsnap-recrypt 1
  11. .Sh SYNOPSIS
  12. .Nm
  13. .Fl -keyfile Ar key-file
  14. .Fl -oldkey Ar old-key-file
  15. .Fl -user Ar user-name
  16. .Fl -machine Ar machine-name
  17. .Op Fl -passphrased
  18. .Op Fl -passphrase-mem Ar maxmem
  19. .Op Fl -passphrase-time Ar maxtime
  20. .Nm
  21. .Fl -version
  22. .Sh DESCRIPTION
  23. .Nm
  24. generates a set of cryptographic keys which are compatible
  25. with an existing set of cryptographic keys, registers with
  26. the tarsnap server, and writes a key file for use with
  27. .Xr tarsnap-recrypt 1
  28. and
  29. .Xr tarsnap 1 .
  30. The term "compatible"
  31. here means that it is possible to re-encrypt archives stored with
  32. the first set of keys to be stored with the second set of keys.
  33. This is required because Tarsnap has some keys which need to stay the same
  34. when re-encrypting data; otherwise, existing archives will become unreadable
  35. and cannot be used for deduplication.
  36. .Pp
  37. The
  38. .Fl -keyfile Ar key-file
  39. option specifies the name of the file in which to write the newly-generated
  40. keys.
  41. The
  42. .Fl -oldkey Ar old-key-file
  43. option specifies the name of the file containing the old keys.
  44. The
  45. .Fl -user Ar user-name
  46. option specifies the name (i.e. email address) of the Tarsnap account.
  47. The
  48. .Fl -machine Ar machine-name
  49. option specifies a name which will be displayed in accounting reports so that
  50. you can see how much data each machine is storing.
  51. .Pp
  52. If the
  53. .Fl -passphrased
  54. option is specified, the user will be prompted to enter a passphrase (twice)
  55. to be used to encrypt the key file.
  56. .Pp
  57. If the
  58. .Fl -passphrase-mem Ar maxmem
  59. option is specified, a maximum of
  60. .Ar maxmem
  61. bytes of RAM will be used in the scrypt key derivation function to
  62. encrypt the key file; it may be necessary to set this option if a key
  63. file is being generated on a system with far more RAM than the system
  64. on which the key file will be used.
  65. .Pp
  66. If the
  67. .Fl -passphrase-time Ar maxtime
  68. option is specified, a maximum of approximately
  69. .Ar maxtime
  70. seconds will be used in the scrypt key derivation function to
  71. encrypt the key file.
  72. .Pp
  73. The
  74. .Fl -version
  75. option prints the version number of
  76. .Nm ,
  77. then exits.