Difference between revisions of "OS4X Core binaries"

From OS4X
Jump to navigation Jump to search
Line 4: Line 4:
 
*<code>ODETTE_CERTIFICATE_DELIVER</code>: send the configured certificate to the partner (also used by updating certificate)
 
*<code>ODETTE_CERTIFICATE_DELIVER</code>: send the configured certificate to the partner (also used by updating certificate)
 
The used cipher suite for automatic certificate is "#1: 3des_ede_cbc_3key, RSA, SHA-1'.
 
The used cipher suite for automatic certificate is "#1: 3des_ede_cbc_3key, RSA, SHA-1'.
 +
 +
When an existing send queue entry already exists (server ID doesn't matter!), then it will be checked if it's blocked. If it's blocked, it will be unblocked, otherwise it will be removed and newly added. If any process is running for that send queue entry (i.e. a process in the status "''taken by send queue''"), it will recognize that its send queue entry was removed and it will cleanly shut down.
  
 
=== input parameters ===
 
=== input parameters ===

Revision as of 19:36, 25 October 2007

os4xeq / os4xeq2

Add a file to the send queue. If the addressed partner is configured for OFTP2, special file handling is available for the following virtual filenames:

  • ODETTE_CERTIFICATE_REQUEST: request certificate from remote partner
  • ODETTE_CERTIFICATE_DELIVER: send the configured certificate to the partner (also used by updating certificate)

The used cipher suite for automatic certificate is "#1: 3des_ede_cbc_3key, RSA, SHA-1'.

When an existing send queue entry already exists (server ID doesn't matter!), then it will be checked if it's blocked. If it's blocked, it will be unblocked, otherwise it will be removed and newly added. If any process is running for that send queue entry (i.e. a process in the status "taken by send queue"), it will recognize that its send queue entry was removed and it will cleanly shut down.

input parameters

  • -h: printf this help text
  • -C <configfile>: use given config file (default: /etc/os4x.conf)
  • -p <partner shortname>
  • -f <filename with absolute path>
  • -v <virtual filename>
  • -c <comment (max. 255 chars./without special chars.)>
  • -q <alternative SSID for this file (originator)>
  • -r <alternative SSID for this file (destination)>
  • -s <alternative SFID for this file (originator)>
  • -t <alternative SFID for this file (destination)>
  • -w <alternative password for this file (originator)>
  • -x <alternative password for this file (destination)>
  • -u <priority, default: 0>
  • -i <server ID, default: 0>
  • -P: add file passive to send queue (let partner fetch it from remote)
  • -d: <optional file description in OFTPv2 session>
  • -V: print out version and exit

examples

  • enqueue the file '/tmp/testfile' to partner 'c-works', using virtual filename 'testfile':
./os4xeq -p c-works -f /tmp/testfile -v testfile
  • enqueue the file '/tmp/testfile' to partner 'c-works', using ENGDAT light virtual filename 'ENG061229153952001001':
./os4xeq -p c-works -f /tmp/testfile -v ENG061229153952001001
  • enqueue the file same file '/tmp/testfile' to partner 'c-works', using ENGDAT light virtual filename 'ENG061229153952001001', but with increased priority (5):
./os4xeq -p c-works -f /tmp/testfile -v ENG061229153952001001 -u 5
  • enqueue the file '/tmp/testfile' to partner 'c-works', using ENGDAT light virtual filename 'ENG061229153952001001', with comment 'this is a testcomment':
./os4xeq -p c-works -f /tmp/testfile -v ENG061229153952001001 -c "this is a testcomment"
  • enqueue the file '/tmp/testfile' to partner 'c-works', using ENGDAT light virtual filename 'ENG061229153952001001', added passively, so partner must fetch the file (no active send):
./os4xeq -p c-works -f /tmp/testfile -v ENG061229153952001001 -P

Certificate exchange:

  • request certificate from OFTP2 partner 'c-works':
./os4xeq -p c-works -f /tmp/testfile -v ODETTE_CERTIFICATE_REQUEST
  • send my certificate to OFTP2 partner 'c-works':
./os4xeq -p c-works -f /tmp/testfile -v ODETTE_CERTIFICATE_DELIVER

os4xlic

This tool displays the OS4X ID, an installation specific hash value, which identifies this copy of OS4X.

input parameters

  • -h: help text
  • -I: display OS4X ID only (without headers)
  • -v: display version information and exit

examples

localhost:~/tmp username$ ./os4xlic 
OS4X license tool v2.0

your OS4X ID is:
8b6c03222dc17af20d4c022d6cf92d502cb8d51b230467582b8d111a39e7b0bcv2

(all in one line)
localhost:~/tmp username$ ./os4xlic -I
8b6c03222dc17af20d4c022d6cf92d502cb8d51b230467582b8d111a39e7b0bcv2

os4x_licinfo

Display the information encoded in an OS4X license file.

input parameters

  • -h: help text
  • -C configfile: use given config file (default: /etc/os4x.conf)
  • -f license file: use the given license file as input
  • -d: display end date of validity
  • -I: display licensed OS4X ID
  • -p: display amount of licensed partners
  • -a: display licensed functions
  • -A: display licensed functions, as numeric value
  • -v: display version information and exit

examples

localhost:~/tmp username$ ./os4x_licinfo -I
8b6c03222dc17af20d4c022d6cf92d502cb8d51b230467582b8d111a39e7b0bcv2
localhost:~/tmp username$ ./os4x_licinfo -f /opt/os4x/bin/license.key -d
20080331

os4xrd / os4xrd2

The main OS4X receive daemon which is responsible for accepting OFTP sessions. This daemon starts several processes:

  • os4xrd: the management process which manages all subsequent child processes
  • os4xrd_tcpip: main receive process for incoming TCP/IP connections. After having accepted a connection, this processes creates a new child process:
    • os4xrd_tcpip_active: an active TCP/IP OFTP connection
  • os4xrd_tcpip_tls: main receive process for incoming TLS secured TCP/IP connections. After having accepted a connection, this processes creates a new child process:
    • os4xrd_tcpip_active: an active TLS secured TCP/IP OFTP connection
  • os4xrd_capi_[number]: main receive process for incoming ISDN connections. The number is the index value of the CAPI configuration row. After having accepted a call, this processes creates a new child process:
    • os4xrd_capi_[number]_active: an active CAPI OFTP connection

input parameters

  • -h: help text
  • -C <configfile>: use given config file (default: /etc/os4x.conf)
  • -f start forced
  • -v: display version
  • -i <serverID>: start as server with ID <serverID> (default: 0)

os4xsqd / os4xsqd2

The send queue daemon checks new entries in the send queue, trying to send them. During processing, the daemon starts the following processes:

  • os4xsqd: the management process which manages all subsequent child processes:
    • os4xsqd_tcpip_active: an active OFTP connection process, running a TCP/IP connection
    • os4xsqd_tcpip_tls_active: an active OFTP connection process, running a TLS secured TCP/IP connection
    • os4xsqd_capi_active: an active OFTP connection process, running an ISDN connection

input parameters

  • -h: help text
  • -C <configfile>: use given config file (default: /etc/os4x.conf)
  • -f start forced
  • -v: display version
  • -i <serverID>: start as server with ID <serverID> (default: 0)