サーバコマンド（hcpdデーモン用）

hcpdデーモンは、リモート（クライアント）からのhcp（ファイル転送）コマンドやhrm（ファイル削除）コマンドの指示を受け付け、その処理を実行するためにサーバ側で待機するソフトウェアです。Linux版で提供されます。

基本書式

基本書式は以下の通りです。

Usage: hcpd [OPTION]...
  or : hcpd -q [OPTION]...
  or : hcpd --auth-keys [OPTION]... [PATH]

オプション一覧

hcpdコマンドのオプションは以下の通りです。

各種監視機能

説明	短縮名	オプション名
フォアグラウンドモード起動	f	foreground
調査モード起動（廃止予定）		investigation

ログ管理機能

説明	短縮名	オプション名
システムログの出力先指定	l	log-file
各種統計ログの出力先指定	L	stat-log-file

ソフトウェアの情報確認

説明	短縮名	オプション名
バージョン確認	V	version
入力パラメータ及び設定情報確認	t	config-test
ヘルプの表示	h	help

システム動作環境設定

説明	短縮名	オプション名
設定ファイルパスの指定	c	config-file
プロセスID出力先の指定	p	pid-file
ライセンスキーのパス指定	k	license
停止シグナルの送信	q	quit

システムの情報確認

説明	短縮名	オプション名
システム情報表示		system-info
システム性能確認		run-host-benchmark
システム性能確認カテゴリ指定		run-host-benchmark-categories

ユーザ公開鍵取得

説明	短縮名	オプション名
authorized_keys取得		auth-keys
authorized_keys取得 UID指定		auth-keys-uid
authorized_keys取得ユーザ指定		auth-keys-user
authorized_keys取得ユーザ定義ファイルパス指定		auth-keys-hcp-users
authorized_keys取得システム認証(PAM)OFF指定		auth-keys-sys-auth-disabled
authorized_keys取得システム認証(PAM)強制追加指定		auth-keys-sys-auth-regardless-user-def
authorized_keys取得補助グループ無効指定		auth-keys-no-supp-groups

各種監視機能

f, foreground

=========================================================================
対応OS : Linux.x86
書式 : -f | --foreground
=========================================================================

hcpdデーモンを、フォアグラウンドモードで起動します。

--
例：
[root@localhost ~]# hcpd -f ...
--

investigation

=========================================================================
対応OS : Linux.x86
書式 : --investigation
=========================================================================

hcpdデーモンを調査モードで起動します。期待しない動作をする場合などに、調査のために詳細なログを出力します。アプリログレベルをDEBUGにして詳細なログを取得してください。多量のログが出力されるため、長時間の使用もしくは性能が必要とされるケースでは使用しません。また、取得したログはユーザが可読な内容ではないため、本製品提供元などへ調査目的等のため送付してください。

このオプションは廃止予定（deprecated）です。代わりにSystemLogLevelもしくはDiagnosticLogLevelをDEBUGにして詳細なログを取得してください。

ログ管理機能

l, log-file

=========================================================================
対応OS : Linux.x86
書式 : -l <log-file-path> | --log-file=<log-file-path>
-------------------------------------------------------------------------
log-file-path
既定値 : なし
値の範囲 : ファイルシステムのパス文字列
=========================================================================

hcpdデーモンのログを指定したパスのファイルに出力します。

--
例：
[root@localhost ~]# hcpd -l /var/log/hcpd.log ...
--

このオプションが指定されなかった場合は、標準出力にログを出力します。

L, stat-log-file

=========================================================================
対応OS : Linux.x86
書式 : -L <log-file-path> | --stat-log-file=<log-file-path>
-------------------------------------------------------------------------
log-file-path
既定値 : なし
値の範囲 : ファイルシステムのパス文字列
=========================================================================

hcpdデーモンが出力する統計ログの基準パスを指定します。

--
例：
[root@localhost ~]# hcpd -L /var/tmp/.hcp.statistics2 ...
--

指定されたパスに接尾辞を付加して各統計ログが出力されます。

<指定されたパス>.system （システム統計）
<指定されたパス>.application （アプリケーション統計）
<指定されたパス>.transport.tcp.service_<サービス番号>.<サービスポート番号>.thread_<スレッド番号> （TCPトランスポート統計）
<指定されたパス>.transport.hpfp.service_<サービス番号>.<サービスポート番号>.thread_<スレッド番号> （HpFPトランスポート統計）
<指定されたパス>.transport.ws.service_<サービス番号>.<サービスポート番号>.thread_<スレッド番号> （WS/WSSトランスポート統計）

非特権ユーザで後述のStatLogPerUserInPrivilegeSeparationが有効(yes)の場合は、次の様なパスに記録されます。

<指定されたパス>.application.<UID>_<GID> (Linux)
<指定されたパス>.application.<Username> (Windows)

指定しない場合は、次のパスに出力します。

/var/tmp/.hcp.statistics

ソフトウェアの情報確認

V, version

=========================================================================
対応OS : Linux.x86
書式 : -V | --version
=========================================================================

hcpdデーモンのバージョンを表示します。

--
例：
[root@localhost ~]# hcpd -V
hcp server (hcpd) 1.5.8_1 / Linux (HpFP2 2.0.0.91_26 WSAPI 0.0.1.36 WS 4.2.0-2)
--

t, config-test

=========================================================================
対応OS : Linux.x86
書式 : -t | --config-test
=========================================================================

hcpdデーモンの入力パラメータ及び設定情報を出力します。

--
例：
[root@localhost ~]# hcpd -t
...

-- [Command Options] ------------------------------------------------------
Command parameters
 foreground  : disable
 version     : disable
 help        : disable
 quit        : disable
 config-test : enable
 pid-file    : - [/var/run/hcpd.pid]
 license     : - [/etc/hcp/license.key]
 config-file : - [/etc/hcp/hcpd.conf]
 log-file    : - [/var/log/hcpd.log]
 stat-log-file   : - [/var/tmp/.hcp.statistics]
 run-host-benchmark : disable
 run-host-benchmark-categories : - [all]
-- [Configuration Parameters] ---------------------------------------------
Configuration parameters
 PubkeyAuthentication             : yes
 PAMAuthentication                : yes
 LocalPasswordAuthentication      : no
 MaxAuthTries                     : 6
 PerformSystemAuthenticationRegardlessUsers : no
 UserDirectoryFallbackAvailable   : no
 RejectOnUserHomeDirectoryNotFound : no
 UsePrivilegeSeparation           : yes [supp_group=yes]
 PrivilegeSeparationMinimumUID    : 0
 PrivilegeSeparationMinimumGID    : 0
 PrivilegeSeparationUser          : nobody
 PrivilegeSeparationUmask         : 0022 -
 PrivilegeSeparationUmaskAnonymous : 0002 -
 ApplyUserPermission              : yes
 AllowUsers                       : -
 AllowGroups                      : -
 DenyUsers                        : -
 DenyGroups                       : -
 UseServerCertificateSecurity     : yes
 RequireServerCertificateSecurity : yes
 HeaderCompress                   : yes
 ContentCompress                  : yes
 OCSPRevocationEnabled            : yes
 AuthorizedKeysSearchDir          : -
 AuthorizedKeysFile               : - [~/.ssh/authorized_keys ~/.hcp/authorized_keys]
 AuthorizedKeysCommand            : -
 LocalUserFile                    : - [/etc/hcp/users usage=overwrite]
 LocalPasswordFile                : - [/etc/hcp/passwd]
 ServerKeyFile                    : - [/etc/hcp/key/server.key]
 ServerCertificateFile            : - [/etc/hcp/cert/server.crt]
 ServerCertificateChainFile       : - [/etc/hcp/cert/chain.crt]
 CACertificateFile                : - [/etc/hcp/cacert.pem]
 CACertificatePath                : - [/etc/ssl]
 CARevocationFile                 : - [/etc/hcp/crl.pem]
 CARevocationPath                 : - [/etc/ssl]
 ProtocolVersion                  : 2
 MaxConcurrentThread              : 0
 MaxTotalConnection               : 150
 MaxTcpConnection                 : 50
 MaxUdpConnection                 : 50
 MaxWsConnection                  : 50
 MaxConnectionPerUser             : 50
 MaxConnectionPerSec              : 50
 MaxRequestFileEntryAtOnce        : 50
 MaxReceiveFileSize               : unlimited
 MaxSendFileSize                  : unlimited
 MaxTotalBufferSize               : 4294967296
 MaxBufferSizePerConnection       : 104857600
 MaxTotalReceiveRate              : 100000000000
 MaxTotalSendRate                 : 100000000000
 MaxReceiveRate                   : 100000000000
 MaxSendRate                      : 100000000000
 MaxConnectionReceiveRate         : 100000000000
 MaxConnectionSendRate            : 100000000000
 InitHeaderBlockSize              : 51200
 InitContentBlockSize             : 1048576
 MaxHeaderBlockSize               : 51200
 MaxContentBlockSize              : 1048576
 TransportTimeout                 : 180 sec
 IdleTimeout                      : 0 sec
 FileLock                         : no
 FileLockTrials                   : 0
 FileLockTrialInterval            : 3 sec
 AtomicLikeSaving                 : no .tmp NONE [threshold=0, reject_ow_req=yes]
 TCPListenAddress                 : 0.0.0.0:874[TCP tcp1, mcd=1]
 HPFPListenAddress                : 0.0.0.0:65520[HpFP udp1, sndbuf=104857600, rcvbuf=209715200, mss=-1, mcd=1]
 ListenServiceBonding             : -
 UDPServiceExtensionBufferSize    : 2147483648
 TCPServiceSocketSendBuffer       : 0
 AcceptableCryptMethod            : AES256/GCM AES256/CTR/VMAC AES256/CBC AES128/CBC [Intel:AES-NI=yes]
 AcceptableDigestMethod           : XXH3 SHA256 SHA160
 RequireDataIntegrityChecking     : yes
 TransportCharEncoding            : UTF8
 DocPoint                         : /home
  DocPath = /home
  HomeIsolation = no
  PermitAccessRead = yes
  PermitAccessWrite = yes
  PermitAccessOverwrite = yes
  PermitAccessDelete = yes
  PermitAccessRandomRead = no
  PermitAccessRandomWrite = no
 DocPointEnd
 HostEncoding                     : UTF8
 SyslogOption                     : LOG_CONS | LOG_PID
 SyslogFacility                   : LOG_DAEMON
 SystemLog                        : INFO yes Rotation[size=no:0:0, pattern=no:] -[/var/log/hcpd.log]
 ApplicationStatLog               : yes Rotation[size=no:0:0, pattern=no:]
 TransportStatLog                 : no Rotation[size=no:0:0, pattern=no:]
 SystemStatLog                    : yes Rotation[size=no:0:0, pattern=no:]
 FileOperationLog                 : no -[/var/log/hcpd.file.operation.log] Rotation[size=no:0:0, pattern=no:]
 CallbackScript                   : no Script[~/.hcp/callback.sh, data=~/.hcp/callback]
 CallbackScriptHomeIsolation      : no [logical=no]
 CallbackScriptNoSymbolicLink     : no
 EnsureDestinationInFileTransfer  : yes
 StatLogPerUserInPrivilegeSeparation : no
 ApplicationStatLogSecurityEx     : yes
 MemoryTransferConcurrency        : 1 (wait_type cond, exp_nsec 1)
 MaxReadRate                      : unlimited
 MaxWriteRate                     : unlimited
 DiskBenchmarkPreAllocation       : none 
 DiskBenchmarkPreAllocationSize   : 0 
 DiskBenchmarkDirectAlignmentSize : 0 
 DiskBenchmarkDirectMalloc        : posix
 DiskBenchmarkAsyncNoWait         : no 
 DiskBenchmarkAsyncMaxEvents      : 16 
 DiskBenchmarkAsyncMaxGetEvents   : 1 
 DiskBenchmarkAsyncGetEventsTimeout : 0 usec
 DiskBenchmarkAsyncRequestPoolSize : 32 
 DeepDiskBenchmarkFileSize        : 17179869184
 DeepDiskBenchmarkFreeSpaceRequired : 34359738368
 DeepDiskBenchmarkBlockSizes      : 16KB 32KB 64KB 256KB 512KB 1MB 2MB 4MB 8MB 16MB 24MB 32MB
------------------------------------------------------------------------------

h, help

=========================================================================
対応OS : Linux.x86
書式 : -h | --help
=========================================================================

hcpdデーモンのヘルプを表示します。

--
例：
[root@localhost ~]# hcpd -h
--

システム動作環境設定

c, config-file

=========================================================================
対応OS : Linux.x86
書式 : -c <config-file-path> | --config-file=<config-file-path>
-------------------------------------------------------------------------
config-file-path
既定値 : なし
値の範囲 : ファイルシステムのパス文字列
=========================================================================

hcpdデーモンが使用する設定ファイルのパスを指定します。一般ユーザ権限でhcpdを使用する場合、ユーザごとに個別設定を行いたい場合などに実行します。

--
例：
[root@localhost ~]# hcpd -c /etc/hcp/hcpd2.conf ...
--

このオプションが指定されなかった場合は、次のファイルから設定を読込みます。

/etc/hcp/hcpd.conf

p, pid-file

=========================================================================
対応OS : Linux.x86
書式 : -p <pid-file-path> | --pid-file=<pid-file-path>
-------------------------------------------------------------------------
pid-file-path
既定値 : /var/run/hcpd.pid
値の範囲 : ファイルシステムのパス文字列
=========================================================================

hcpdデーモンプロセスのプロセスIDを出力するファイルパスを指定します。

--
例：
[root@localhost ~]# hcpd -p /var/run/hcpd2.pid ...
--

複数のデーモンプロセスを起動する場合もしくは既に他のデーモンプロセスが起動している場合は、同じファイルパスを使用しないようにご注意ください。

k, license

=========================================================================
対応OS : Linux.x86
書式 : -k <license-key-path> | --license=<license-key-path>
-------------------------------------------------------------------------
license-key-path
既定値 :
 /etc/hcp/license.key
値の範囲 : ファイルシステムのパス文字列
=========================================================================

ライセンスキーのパスを指定します。

--
例：
[root@localhost ~]# hcpd -k /etc/hcp/license2.key ...
--

指定しない場合は、次のパスからライセンスキーを読込みます。

/etc/hcp/license.key

ライセンスキーが読み込めない場合は、トライアルライセンスが次の要件で適用されます。

合計スループット制限 1Gbps
スループット制限 1Gbps
TCP最大接続数 3
HpFP最大接続数 3
WS/WSS最大接続数 3
最大多重接続数 1

q, quit

=========================================================================
対応OS : Linux.x86
書式 : -q | --quit
=========================================================================

hcpdデーモンを停止するシグナルを送信します。

pid-fileオプションで指定されたファイルもしくは既定のファイルからプロセスIDを取得し、このプロセスIDを指定してシグナルを送信します。

--
例：
[root@localhost ~]# hcpd -q ...
--

システムの情報確認

system-info

=========================================================================
対応OS : Linux.x86
書式 : --system-info
=========================================================================

システム情報を表示します。次の内容が表示されます。

CPUブランド名
物理プロセッサ数及び論理プロセッサ数
AES等ハードウェアアクセラレーション情報
システムメモリ容量
カーネル情報 (Linux)
OS情報
ホスト名

2回指定すると次の情報を表示します。

ディスク消費情報 (df出力, Linux)
ネットワークインターフェース詳細情報
```
--
例：
[root@localhost ~]# hcpd --system-info ...
--
```

run-host-benchmark

=========================================================================
対応OS : Linux.x86
書式 : --run-host-benchmark
=========================================================================

次の項目に関してホスト性能の測定を行います。

セキュリティ通信性能 (AES, GCM/CTR/CBCモード, MD5, SHA1, SHA256)
ファイルデータ検査性能 (XXH3, Parity)
ディスク読書性能 (Cached, Direct I/O)
メモリコピー性能

二回指定すると次の項目に関して測定条件を追加してより詳細な測定を行います。

セキュリティ通信性能測定 (追加のブロックサイズまたは並列度に応じたAES暗号性能測定)
ファイルデータ検査性能 (Parity計算測定)
ディスク読書性能 (ブロックサイズに応じた測定)

メモリコピー性能 (並列度を上げて測定)

--
例：
[root@localhost ~]# hcpd --run-host-benchmark ...
--

run-host-benchmark-categories

=========================================================================
対応OS : Linux.x86
書式 : --run-host-benchmark-categories=<categories>
-------------------------------------------------------------------------
categories
既定値 : all
値の範囲 : secure, integrity, disk, memory, all
=========================================================================

ホスト性能の計測において、計測を実施するカテゴリを指定します。次の値を指定できます。

secure (セキュリティ通信性能)
integrity (ファイルデータ検査性能)
disk (ディスク読書性能)
memory (メモリコピー性能)
all (上記すべて)

計測時間が長い場合に、計測を特定の項目に絞りたい場合などに使用します。

--
例：
[root@localhost ~]# hcpd --run-host-benchmark-categories=disk,memory ...
--

ユーザ公開鍵取得

auth-keys

=========================================================================
対応OS : Linux.x86
書式 : --auth-keys
=========================================================================

ユーザのホームディレクトリに設置された次の公開鍵データを取得するように指示します。取得したデータは標準出力に出力されます。

~/.ssh/authorized_keys
~/.hcp/authorized_keys

本オプションを指定した場合は、サービスデーモンとしては動作しません。

パスを指定した場合は、そのパスのファイルに公開鍵データが保管されていると見做してデータを取得します。

本オプションは、hcpdサービスデーモンによる公開鍵認証時の公開鍵参照に使用するために定義されています。調査等の目的で使用する場合などを除き、通常は利用しません（サポート対象外）。

--
例：
[root@localhost ~]# hcpd --auth-keys ... "~/.hcp/authorized_keys" // .hcp配下の鍵のみ取得。クオートによるチルダ展開抑制
--

auth-keys-uid

=========================================================================
対応OS : Linux.x86
書式 : --auth-keys-uid=<uid>
-------------------------------------------------------------------------
uid
既定値 : なし
値の範囲 : UID番号
=========================================================================

公開鍵データの取得処理で使用するUIDを指定します。

--
例：
[root@localhost ~]# hcpd --auth-keys --auth-keys-uid=1000 ...
--

auth-keys-user

=========================================================================
対応OS : Linux.x86
書式 : --auth-keys-user=<user_name>
-------------------------------------------------------------------------
user_name
既定値 : なし
値の範囲 : Unixアカウントユーザ名
=========================================================================

公開鍵データの取得処理で使用するユーザ名を指定します。

--
例：
[root@localhost ~]# hcpd --auth-keys --auth-keys-uid=user01 ...
--

auth-keys-hcp-users

=========================================================================
対応OS : Linux.x86
書式 : --auth-keys-hcp-users=<user_def_file_path>
-------------------------------------------------------------------------
user_def_file_path
既定値 : /etc/hcp/users
値の範囲 : ユーザ定義ファイルのパス文字列
=========================================================================

公開鍵データの取得処理で使用するユーザ定義ファイルのパス文字列を指定します。

--
例：
[root@localhost ~]# hcpd --auth-keys --auth-keys-hcp-users=/etc/hcp/users.another.def ...
--

auth-keys-sys-auth-disabled

=========================================================================
対応OS : Linux.x86
書式 : --auth-keys-sys-auth-disabled
=========================================================================

公開鍵データの取得処理でシステム認証(PAM)が無効と見做して処理を行います。

--
例：
[root@localhost ~]# hcpd --auth-keys --auth-keys-sys-auth-disabled ...
--

auth-keys-sys-auth-regardless-user-def

=========================================================================
対応OS : Linux.x86
書式 : --auth-keys-sys-auth-regardless-user-def
=========================================================================

公開鍵データの取得処理でユーザ定義に関わらずシステム認証(PAM)が行われると見做して処理を行います。

--
例：
[root@localhost ~]# hcpd --auth-keys --auth-keys-sys-auth-regardless-user-def ...
--

auth-keys-no-supp-groups

=========================================================================
対応OS : Linux.x86
書式 : --auth-keys-no-supp-groups
=========================================================================

公開鍵データの取得処理で補助グループを無効にします。

--
例：
[root@localhost ~]# hcpd --auth-keys --auth-keys-no-supp-groups ...
--

サーバコマンド（hcpdデーモン用）

基本書式​

オプション一覧​

各種監視機能​

f, foreground​

investigation​

ログ管理機能​

l, log-file​

L, stat-log-file​

ソフトウェアの情報確認​

V, version​

t, config-test​

h, help​

システム動作環境設定​

c, config-file​

p, pid-file​

k, license​

q, quit​

システムの情報確認​

system-info​

run-host-benchmark​

run-host-benchmark-categories​

ユーザ公開鍵取得​

auth-keys​

auth-keys-uid​

auth-keys-user​

auth-keys-hcp-users​

auth-keys-sys-auth-disabled​

auth-keys-sys-auth-regardless-user-def​

auth-keys-no-supp-groups​

基本書式

オプション一覧

各種監視機能

f, foreground

investigation

ログ管理機能

l, log-file

L, stat-log-file

ソフトウェアの情報確認

V, version

t, config-test

h, help

システム動作環境設定

c, config-file

p, pid-file

k, license

q, quit

システムの情報確認

system-info

run-host-benchmark

run-host-benchmark-categories

ユーザ公開鍵取得

auth-keys

auth-keys-uid

auth-keys-user

auth-keys-hcp-users

auth-keys-sys-auth-disabled

auth-keys-sys-auth-regardless-user-def

auth-keys-no-supp-groups