You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
calculate-utils-3-core/man/cl-core.1

201 lines
4.8 KiB

.TH CL-API-SERVER 1 "March 11, 2012" "Calculate Utilities" "Calculate API Server"
.SH NAME
.PP
cl-core - The server part of package calculate-api
.SH SYNOPSIS
[-l] [-p] [-c] [--req] [--sc] [-d] [--db] [--rm] [--right-add] [--right-del]
[--gen-root-cert] [--gen-cert-by] [--get-cert-from] [--use-root-as-server]
[--sign-client] [--sign-server] [--del-req] [--rv] [--version] [-h]
.SH DESCRIPTION
.PP
cl-core - currently no description.
.SH OPTIONS
.PP
Options for
\fBcl-core\fR:
.PP
\fB\-l\fR, \fB\-\-lang\fR \fILANG\fR
.RS 4
Language choice. LANG - language translation, for example ru, english, en.
.RE
.PP
\fB\-p\fR, \fB\-\-port\fR \fIport number\fR
.RS 4
.RE
.PP
\fB\-c\fR, \fB\-\-cert\fR \fIID\fR
.RS 4
Operations with certificates. ID - certificate number or 'all'. If use this option Server not run.
.RE
.PP
\fB\-r\fR, \fB\-\-show-request\fR \fIREQ_ID\fR
.RS 4
View clients requests. ID - request number or 'all'. If use this option Server not run.
.RE
.PP
\fB\-\-sc\fR, \fB\-\-server-cert\fR \fICERT_ID\fR
.RS 4
View servers certificates and requests. CERT_ID - certificate (request) number or 'all'. If use this option Server not run.
.RE
.PP
\fB\-d\fR, \fB\-\-dump\fR
.RS 4
Dump. Use with keys '-c' or '-r'. When used with options 'all' will give details information about all certificates. If you specify a certificate number will give his contents.
.RE
.PP
\fB\-\-db\fR, \fB\-\-debug\fR
.RS 4
Debugging mode (debug).
.RE
.PP
\fB\-\-rm\fR, \fB\-\-remove\fR
.RS 4
Remove certificate. Use with key '-c'.
.RE
.PP
\fB\-\-right-add\fR \fIRIGHT_ADD\fR
.RS 4
Add rights for certificate. Supported by a list of certificates and a list of rights (via ','). Use with key '-c'. When used with --right-del, first added right, and then removed.
.RE
.PP
\fB\-\-right-del\fR \fIRIGHT_DEL\fR
.RS 4
Remove rights certificate. Supported by a list of certificates and a list of rights (via ','). Use with key '-c'. When used with --right-add first added right, and then removed.
.RE
.PP
\fB\-\-gen-root-cert\fR
.RS 4
Generate a root certificate (CA certificate).
.RE
.PP
\fB\-\-gen-cert-by\fR \fIHOST\fR
.RS 4
Send request to sign root certificate. HOST - network address of destination host (IP or HOSTNAME).
.RE
.PP
\fB\-\-get-cert-from\fR \fIROOT_HOST\fR
.RS 4
Get signed certificate from server. ROOT_HOST - network address of destination host (IP or HOSTNAME).
.RE
.PP
\fB\-\-use-root-as-server\fR
.RS 4
Use root certificate as a server certificate.
.RE
.PP
\fB\-\-sign-client\fR \fIID_CLIENT_REQ\fR
.RS 4
Sign client's request by server certificate. ID_CLIENT_REQ - request number.
.RE
.PP
\fB\-\-sign-server\fR \fIID_SERVER_REQ\fR
.RS 4
Sign server's request by root certificate. ID_SERVER_REQ - request number.
.RE
.PP
\fB\-\-del-req\fR \fIID_DEL_REQ\fR
.RS 4
Refuse to sign request. ID_DEL_REQ - request number.
.RE
.PP
\fB\-\-rv\fR, \fB\-\-revoke-cert\fR \fIREVOKE_CERT_ID\fR
.RS 4
Revoke early signed server (or ca) certificate. Use value rm for REVOKE_CERT_ID to remove CRL.
.RE
.PP
\fB\-\-version\fR
.RS 4
Prints program version and exit.
.RE
.PP
\fB\-h\fR, \fB\-\-help\fR
.RS 4
Prints help and exits.
.RE
.SH SEE ALSO
.PP
cl-console-gui(1)
.SH EXAMPLES
.PP
Generate a root certificate
.nf
cl-core --gen-root-cert
.fi
.PP
Sending request to a remote server with address 192.168.0.155
.nf
cl-core -gen-cert-by 192.168.0.155
.fi
.PP
For certificates with numbers 1,2 and 5 add rights to methods user-mod, group-mod and detele rights to method cl-install.
.nf
cl-core -c 1,2,5 --right-add user-mod,group-mod --right-del cl-install
.fi
.PP
View information about all certificates.
.nf
cl-core -c all -d
.fi
.PP
Start server in debug mode with English localization.
.nf
cl-core --debug --lang en
.fi
.PP
Remove certificate with number 7.
.nf
cl-core -c 7 --remove
.fi
.SH FILES
.PP
\fB/var/calculate/server
.RS 4
Directory with clients and servers request and signed certificates, rights certificates (groups), information abuon sessions and processes.
.RE
.PP
\fB/var/calculate/server/ca
.RS 4
Directory with server certificates, root and CA certificates.
.RE
.PP
\fB/var/calculate/server/client_certs
.RS 4
Clients request and signed certificates.
.RE
.PP
\fB/var/calculate/server/server_certs
.RS 4
Servers request and signed certificates.
.RE
.PP
\fB/var/calculate/server/conf/group_right.conf
.RS 4
List of methods available for groups.
.nf
Example of content:
.fi
.nf
manager pid_info,list_pid,cl_template,cl_login
.fi
.RE
.PP
\fB/var/calculate/server/conf/right.conf
.RS 4
list of number certificates who are allowed (forbidden) execution of the method.
.nf
Example of content:
.fi
.nf
pid_info 2 -1
.fi
.RE
.RS 4
Certificate number 2 has right to run method "pid_info", and the certificate number 1 does not have rights. Use key --right-add and --right-del.
.RE
.SH AUTHORS
.PP
Calculate Utilities are developed by Calculate Ltd. http://www.calculate.ru
.SH AUTHOR
.PP
This man page was originally written by Calculate Ltd. http://www.calculate.ru