Blame winpr/tools/makecert-cli/winpr-makecert.1.in

Packit Service fa4841
.de URL
Packit Service fa4841
\\$2 \(laURL: \\$1 \(ra\\$3
Packit Service fa4841
..
Packit Service fa4841
.if \n[.g] .mso www.tmac
Packit Service fa4841
.TH winpr\-makecert 1 2017-01-11 "@FREERDP_VERSION_FULL@" "FreeRDP"
Packit Service fa4841
.SH NAME
Packit Service fa4841
winpr\-makecert \- A tool to create X.509 certificates.
Packit Service fa4841
.SH SYNOPSIS
Packit Service fa4841
.B winpr\-makecert
Packit Service fa4841
[\fB-rdp\fP]
Packit Service fa4841
[\fB-silent\fP]
Packit Service fa4841
[\fB-live\fP]
Packit Service fa4841
[\fB-format\fP { \fIcrt\fP | \fIpem\fP | \fIpfx\fP }]
Packit Service fa4841
[\fB-p\fP password]
Packit Service fa4841
[\fB-n\fP common_name]
Packit Service fa4841
[\fB-y\fP years]
Packit Service fa4841
[\fB-m\fP months]
Packit Service fa4841
[\fB-len\fP length]
Packit Service fa4841
[\fB-#\fP serial]
Packit Service fa4841
[\fB-a\fP { \fImd5\fP | \fIsha1\fP | \fIsha256\fP | \fIs384\fP | \fIsha512\fP }]
Packit Service fa4841
[\fB-path\fP outputpath] 
Packit Service fa4841
[outputname]
Packit Service fa4841
.SH DESCRIPTION
Packit Service fa4841
.B winpr-makecert
Packit Service fa4841
is a tool for generating X.509 certificates modeled after the Windows command
Packit Service fa4841
MakeCert. winpr-makecert aims to be command line compatible with MakeCert
Packit Service fa4841
however not all options are supported or implemented yet.
Packit Service fa4841
Packit Service fa4841
Unimplemented features are not described here. They are marked as "Unsupported"
Packit Service fa4841
in winpr-makecerts help.
Packit Service fa4841
Packit Service fa4841
In contrast to it's Windows counterpart winpr\-makecert does, unless the
Packit Service fa4841
\fB\-live\fP option is given, always creates and save a certificate.
Packit Service fa4841
If \fIoutputname\fP isn't set it is tried to determine the host name of the
Packit Service fa4841
computer the command is run on.
Packit Service fa4841
.br
Packit Service fa4841
\fBWarning:\fP if the file already exists it will be overwritten without asking.
Packit Service fa4841
Packit Service fa4841
Without further options the generated certificates have the following properties:
Packit Service fa4841
Packit Service fa4841
* 2048 bit long
Packit Service fa4841
.br
Packit Service fa4841
* sha256 as hash algorithm
Packit Service fa4841
.br
Packit Service fa4841
* the detected host name is used as common name
Packit Service fa4841
.br
Packit Service fa4841
* a time stamp is used as serial number
Packit Service fa4841
.br
Packit Service fa4841
* validity period of one year
Packit Service fa4841
.br
Packit Service fa4841
* saved in the current working directory in crt format
Packit Service fa4841
.SH OPTIONS
Packit Service fa4841
.IP "-rdp"
Packit Service fa4841
Dummy parameter. Can be used to quickly generate a certificate with default
Packit Service fa4841
properties without specifying any further parameters.
Packit Service fa4841
.IP "-silent"
Packit Service fa4841
Don't print the generated certificate to stdout.
Packit Service fa4841
.IP "-f format"
Packit Service fa4841
Three formats are supported: crt, pem and pfx.
Packit Service fa4841
.br
Packit Service fa4841
\fIcrt\fP outputs the key and the certificate in a separate file each with the file
Packit Service fa4841
endings .key and .crt.
Packit Service fa4841
.br
Packit Service fa4841
\fIpem\fP outputs the key and certificate into a single file with the file ending pem.
Packit Service fa4841
.br
Packit Service fa4841
And \fIpfx\fP outputs key and certificate into a  pkcs12 file with the ending .pfx.
Packit Service fa4841
.IP "-p password"
Packit Service fa4841
Password to use if the pfx format is used as format.
Packit Service fa4841
.IP "-live"
Packit Service fa4841
Don't write the key/certificate to disk. When used from the command line this
Packit Service fa4841
can be thought as "dummy" mode.
Packit Service fa4841
.IP "-n common_name"
Packit Service fa4841
The common name to use in the certificate.
Packit Service fa4841
.IP "-m months"
Packit Service fa4841
Validity period in months.
Packit Service fa4841
.IP "-y years"
Packit Service fa4841
Validity period in years. If months and years are specified the specified
Packit Service fa4841
month parameter will take precedence.
Packit Service fa4841
.IP "-len length"
Packit Service fa4841
Key length in bits to use.
Packit Service fa4841
.IP "-a { \fImd5\fP | \fIsha1\fP | \fIsha256\fP | \fIs384\fP | \fIsha512\fP }"
Packit Service fa4841
The hashing algorithm to use.
Packit Service fa4841
.IP "-# serial"
Packit Service fa4841
The serial number to use for the certificate.
Packit Service fa4841
.IP "-path"
Packit Service fa4841
A directory where the certificate should be created in.
Packit Service fa4841
.IP "outputname"
Packit Service fa4841
The base name of the created file(s). A suffix, the format specific suffix is
Packit Service fa4841
appended to this name.
Packit Service fa4841
.SH EXAMPLES
Packit Service fa4841
winpr-makecert -rdp
Packit Service fa4841
Packit Service fa4841
Creates a certificate with the default properties, saved to a file in the
Packit Service fa4841
current working directory in crt format named like the host. If the host is
Packit Service fa4841
named freerdp the created files are called freerdp.key and freerdp.crt. 
Packit Service fa4841
Packit Service fa4841
Packit Service fa4841
winpr-makecert -len 4096 -a sha384 -path /tmp -# 22 -m 144 -y 1 -format crt mycert
Packit Service fa4841
Packit Service fa4841
The command above creates the file /tmp/mycert.pem containing a key and a
Packit Service fa4841
certificate with a length of 4096. It will use sha384 as hash algorithm.
Packit Service fa4841
The certificate has the serial number 22 and is valid for 12 years (144 months).
Packit Service fa4841
.SH EXIT STATUS
Packit Service fa4841
.TP
Packit Service fa4841
.B 0
Packit Service fa4841
Successful program execution.
Packit Service fa4841
.TP
Packit Service fa4841
.B 1
Packit Service fa4841
Otherwise.
Packit Service fa4841
Packit Service fa4841
.SH SEE ALSO
Packit Service fa4841
Packit Service fa4841
.URL  "https://msdn.microsoft.com/library/windows/desktop/aa386968.aspx" "MakeCert help page" 
Packit Service fa4841
Packit Service fa4841
.SH AUTHOR
Packit Service fa4841
FreeRDP <team@freerdp.com>