make-prc-key.1 2.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  1. .TH MAKE-PRC-KEY 1 "27 December 2014" "" Panda3D
  2. .SH NAME
  3. make-prc-key \- generate keys for signing .prc files
  4. .SH SYNOPSIS
  5. .B make-prc-key
  6. [\fIopts\fP]
  7. 1[,"\fIpass_phrase\fP"] [2[,"\fIpass_phrase\fP"] 3 ...]
  8. .SH DESCRIPTION
  9. This program generates one or more new keys to be used for signing
  10. a prc file. The key itself is a completely arbitrary random bit
  11. sequence. It is divided into a public and a private key; the public
  12. key is not secret and will be compiled into libdtool, while the private
  13. key should be safeguarded and will be written into a .cxx file that
  14. can be compiled as a standalone application.
  15. .PP
  16. The output is a public and private key pair for each trust level. The
  17. form of the output for both public and private keys will be compilable
  18. C++ code; see \-a and \-b, below, for a complete description.
  19. .PP
  20. After the options, the remaining arguments list the individual trust
  21. level keys to generate. For each integer specified, a different key
  22. will be created. There should be one key for each trust level
  23. required; a typical application will only need one or two keys.
  24. .SH OPTIONS
  25. .TP
  26. .BI "\-a " pub_outfile.cxx
  27. Specifies the name and location of the public key output file
  28. to generate. This file must then be named by the Config.pp
  29. variable PRC_PUBLIC_KEYS_FILENAME so that it will be compiled
  30. in with libdtool and available to verify signatures. If this
  31. option is omitted, the previously-compiled value is used.
  32. .TP
  33. .BI "\-b " priv_outfile#.cxx
  34. Specifies the name and location of the private key output file(s)
  35. to generate. A different output file will be generated for each
  36. different trust level; the hash mark '#' appearing in the file
  37. name will be filled in with the corresponding numeric trust level.
  38. The hash mark may be omitted if you only require one trust level.
  39. When compiled against dtool, each of these files will generate
  40. a program that can be used to sign a prc file with the corresponding
  41. trust level.
  42. .TP
  43. .BI "\-p " passphrase
  44. Uses the indicated pass phrase to encrypt the private key.
  45. This specifies an overall pass phrase; you may also specify
  46. a different pass phrase for each key by using the
  47. \fIkey\fB,"\fIpassphrase\fB"\fR syntax.
  48. .PP
  49. If a pass phrase is not specified on the command line, you will be
  50. prompted interactively. Every user of the signing programs
  51. (outfile_sign1.cxx, etc.) will need to know the pass phrase
  52. in order to sign prc files.
  53. .PP
  54. If this is specified as the empty string (""), then the key
  55. will not be encrypted, and anyone can run the signing
  56. programs without having to supply a pass phrase.