SSTP/1.x¶

参考：SSTP（外部サイト）

現在のところDirectSSTPについてはWindowsの仕様に大きく依存しており、他OSでの実装を想定していません。
IPCの仕組み自体は他OSにも存在するため、別途仕様を規定することが望ましいと思われます。
もし仕様が決定した場合は別途掲載を考えておりますので、Ukadoc Projectまでご連絡ください。

概要¶

SSTPはゴースト間の汎用通信仕様です。単純なSakuraScriptの再生や、外部からのイベント通知等に使えます。
通信は基本的にはTCP/IPで行われます。ポート9801または9821(SSPのみ)をリスニングしており、SSTPプロトコルに従ってリクエストを投げると、処理結果が返ってきます。
セキュリティ上の都合で、現在は設定を変更しない限りlocalhost限定でのリスニングとなり、端末外部からは通信できません。また、昔はポート11000番もリスニングしていましたが、マルウェアによる通信と誤認されたことから現在では廃止されています。
起動時に待ち受け先を一時的に指定する--sstp-listenなど、SSPの起動オプションについてはSSPヘルプの起動オプションを参照してください。
IANAのPort number registryには7743と9801番が登録されていますが、実運用されているのは9801番のみです。
同じ略称のプロトコルにMicrosoftが策定したVPN通信のためのSecure Socket Tunneling Protocolがありますが、技術上の関連性はありません。
既定では毎回通信終了時に切断されます。頻繁に通信する場合は、HTTPと同様のkeep-aliveで接続を使い回すことができます [SSP 2.9.03]。

Direct SSTP¶

Direct SSTPはOSに強く依存したIPCの仕組みを利用した通信仕様です。プロトコル仕様は(Socket) SSTPと同じですが、比較的処理が重いTCP/IPを使用せず、直接ゴーストを指定して軽量な通信を行うことを目的としています。
現在のところWindows上のみ仕様が決まっており、下記の通りとなります。

WM_COPYDATAをSendMessage系関数で送信(Postは不可)
SendMessageのhWnd = 通信先ゴーストのHWND FMOから取得
wParam = 返信先の「自身の」HWND レスポンスはWM_COPYDATAを指定したHWND（ウインドウ）で受ける。
lParam = COPYDATASTRUCTへのポインタ
copydatastruct.lpData = SSTPプロトコルに従った文字列
copydatastruct.cbData = 文字列の長さ
copydatastruct.dwData = 9801
備考：
送信側は安全のためlpDataにゼロ終端の文字列を用意し、cbDataにはゼロ終端を含むことが望ましい。
受信側は安全のためゼロ終端を期待せず、必ずcbDataを考慮して処理を行うこと。
受信側は通信先として指定されたHWNDを、受信すべきゴーストがSSTPプロトコル内で指定されたものと同等として取り扱い、できる限りそのゴーストを優先する。
受信側・送信側共にウインドウを1つ以上持つGUIアプリのみを想定しており、コンソールアプリでは使用できない。

同じ方法でSAORI/1.0の要求を送り、ベースウェアの内蔵モジュールを呼び出すこともできます。SAORI over DirectSSTPを参照してください。[SSP 2.9.13]

SSTP over HTTP¶

SSTP over HTTPは、SSP 2.6.32で実装された、HTTPリクエストメッセージボディにSSTPリクエストをそのまま突っ込み、HTTPレスポンスボディにSSTPレスポンスがそのまま返ってくるきわめて単純な仕組みです。
ElectronなどJavaScriptを使ってアプリを作った時に、より簡単にSSTP通信をやりとりするために使うのを想定しています。
localhost:9801(または別途指定されたSSTPポート) に対して、 /api/sstp/v1 に Content-Type: text/plainでHTTP/1.1でPOSTしてください。
レスポンスもそのまま、HTTP/1.1 200 OKのContent-Type: text/plainで返ってきます。
SSTPがエラーでもHTTPは200 OKな点に注意してください。
なお、Content-Lengthヘッダは必須で、無ければエラーになります。
HTTPのkeep-aliveに対応しています。HTTP/1.1では既定で接続が維持され、Connection: close で切断されます(HTTP/1.0は Connection: keep-alive の明示時のみ維持)。Transfer-Encoding(chunked等)付きのリクエストでは維持されません。このとき接続の維持はHTTP側の指定だけで決まり、メッセージボディ中のSSTPのConnectionヘッダは無視されます [SSP 2.9.03]。

お試し

既存のjsライブラリは、jsでSSTP over HTTPを行うために使用できます。

注意：Originヘッダがlocalhostを指していない場合は、強制的にリモートアドレスからのSSTPリクエストとして扱われ、SakuraScriptタグや実行できるSSTPメソッドに強い制約がかかり、かつSecurityLevelヘッダも無視されます。
この制約は、HTTPのOriginがlocalhost、かつSSTPのSecurityLevelがlocalの場合のみ緩和されます。

keep-alive¶

SSP 2.9.03以降、(Socket) SSTPでもHTTPと同様のkeep-aliveにより、1本のTCP接続で複数のリクエストを続けて送ることができます [SSP 2.9.03]。
接続確立の手間を省けるので、短い間隔で何度もSSTPを送るクライアントに向いています。

requestに Connection: keep-alive ヘッダを付けたときだけ接続が維持されます(HTTP/1.0と同じ明示指定方式)。付けなければ従来どおり応答後に切断され、応答の内容も従来と変わりません。
SSTP/1.xのみが対象です。それ以外のバージョンではConnectionヘッダは無視され、常に切断されます。
Direct SSTPは接続の概念が無いため対象外です。SSTP over HTTPはHTTP側のkeep-aliveの規則に従います(SSTP over HTTP参照)。
requestにConnectionヘッダがあった場合、responseにも必ずConnectionヘッダが付きます。
Connection: keep-alive と Keep-Alive: timeout=秒数 が返れば接続は維持されています。
Connection: close が返った場合は応答後に切断されます(同時に維持できる接続数の上限に達した場合など)。
接続が維持される応答では、追加データがあれば必ずCharsetとContent-Lengthヘッダが付き、追加データの後ろに空行は付きません。追加データが無ければヘッダ直後の空行で終わります。
また、切断される従来の応答の末尾に付いていたゼロ終端(0x00)は送られません。応答の終わりは空行とContent-Lengthだけで判断してください。
次のrequestは、前のresponseを受け取り終えてから送ってください(パイプライン非対応)。responseより先に次のrequestを送った場合、その応答で切断されることがあります。
requestの末尾にゼロ終端などの余分なバイトを付けないでください。次のrequestの一部とみなされます。
responseの後、Keep-Aliveのtimeoutで示された秒数(SSP 2.9.03では5秒)の間に次のrequestが無ければ、SSP側から切断されます。クライアントはいつ切断されても再接続して送り直せるようにしてください。

requestサンプル¶

EXECUTE SSTP/1.4
Charset: UTF-8
Sender: SSTPクライアント
Command: GetVersion
Connection: keep-alive

responseサンプル(接続維持・データあり)¶

SSTP/1.4 200 OK
Charset: UTF-8
Connection: keep-alive
Keep-Alive: timeout=5
Content-Length: 24

追加データはここ

responseサンプル(切断・データなし)¶

SSTP/1.4 204 No Content
Charset: UTF-8
Connection: close

request/response¶

SHIORIなど他のプロトコルと同じく、HTTPに似せた独自プロトコルです。
リクエストのCharset指定は必須で、指定が無い場合はエラーとなるか、OS標準指定の文字コードとして解釈されます。

改行コードはCR+LF。
リクエストの最後は空行（前行の終端と合わせて(CR+LF)x2）で終わる。
レスポンスの最後にはEXECUTEなどの場合追加データが入ることがある。ヘッダ終了後空行を一つ挟み、追加データが入り、さらに空行が1つ入って終了となる。追加データが無い場合はヘッダ直後の空行だけで終わる場合がある。
追加データありのレスポンスでは、互換性の都合でCharsetを含むヘッダが一切無く追加データだけが返る場合がある。その場合はリクエストの文字コードと同じと仮定して良い。
リクエストとレスポンスのSSTPバージョンが異なる場合がある。バージョン番号に依存する解釈はしないこと。

request¶

requestサンプル¶

SEND SSTP/1.0
Charset: UTF-8
Sender: SSTPクライアント
Script: \h\s0テストー。\u\s[10]テストやな。
Option: notranslate

requestの各メソッドに共通するヘッダ¶

メソッド固有のものについては、後ろのメソッド別の説明を確認すること。

Charset: リクエストの文字コード。一番最初の行に現れるのが望ましい。
特に理由がなければUTF-8を推奨する。
Sender: 送信者を示す文字列。「SSTP送信ツール」など。COMMUNICATEメソッドの場合は、送信元のゴースト\0名。
SecurityLevel: SHIORIやSakuraScriptで処理する際のセキュリティレベルの指定。local/externalのいずれか。
DirectSSTP、または127.0.0.1等明らかにローカルから来たリクエストのみ有効。
SSTP over HTTPは、localhostから配信されたhtml等から送られた場合を除き、常にexternalとみなされる。
SecurityOrigin [SSP 2.6.59]: 送信元サーバを示すURL風の文字列。以下の形式となる。HTTPヘッダのOriginと考え方は同じ。
SecurityOrigin: null
SecurityOrigin: <scheme>://<hostname>
SecurityOrigin: <scheme>://<hostname>:<port>
scheme は通常、http,https,sstpのいずれか。hostnameは送信元サーバ名かIP。portは返信受付可能なポート。
特に指定がない場合は、nullが指定されたものとみなされる。
SSTP over HTTPは、HTTPのOriginヘッダの中身が常に設定され、SSTPの中のSecurityOriginは無視される。
Option: SSTPで実行されるSakuraScriptがどのように扱われるかのオプションを指定する。
カンマ区切りで複数指定可能。指定する文字列は以下の通り。
nodescript : バルーンのSSTP表示を無効にする(リモートからのSSTPは無効)
notranslate : OnTranslateやMAKOTOでのトランスレート処理を行わない
nobreak : 現在実行中のスクリプトを中断せず、終わるまで待つ
strict : SakuraScriptの解釈に失敗した箇所をエラーログに記録する。対象は存在しないサーフェス(\s)・アニメーション(\i)・バルーン(\b)の指定、未知のタグ・\![コマンド]・\&[実体参照]、必要な[]や数字の欠け、\p・\b・\n・\c・\qの不正な値。SENDのスクリプトと、NOTIFY/GIVEでゴーストが返したスクリプトに有効 [SSP 2.8.94]
ID: "Owned SSTP"と呼ばれるもの。SHIORI uniqueidで送られてきたIDか、FMOの識別ID(SSPのみ)を指定すると、各種セキュリティチェックやロック等を無視して、本SSTPをゴースト内部での処理と同じ優先度で扱う。
SecurityLevel指定がlocalになり、さらに\tなどの割り込み禁止状態でも強制的に割り込み再生を可能とする。
X-SSTP-PassThru-(任意の文字列): NOTIFYなどゴースト側との通信の際に、SHIORIに直接渡されるヘッダ。
文字コード変換等最低限の処理が行われるだけで、(任意の文字列)の部分や中身はそのまま中継される。
HWnd: DirectSSTP限定で、responseを返信すべきウインドウハンドルを示す。
ウインドウハンドル(ポインタ相当)のデータを符号なし10進整数として扱い、それを文字列化したもの。
省略時はWM_COMMUNICATEのwParam。
ReceiverGhostHWnd [SSP 2.5.57]: (Socket)SSTP限定で、requestを送るべきゴーストの\0のウインドウハンドルを示す。
これを指定すると、処理すべきゴーストが固定され、Socket経由でもDirectSSTPと同じ処理が可能になる。
見つからなかった場合は、404 Not Foundで即時エラー終了する。
ReceiverGhostName [SSP 2.5.57]: (Socket)SSTP限定で、requestを送るべきゴーストの\0名を示す。
これを指定すると、処理すべきゴーストが固定され、Socket経由でもDirectSSTPと同じ処理が可能になる。HWndの名前版。
見つからなかった場合は、404 Not Foundで即時エラー終了する。

response¶

responseサンプル(データなし)¶

SSTP/1.4 200 OK
Charset: UTF-8
Script: \h\s0テストー。\u\s[10]テストやな。

responseサンプル(データあり)¶

SSTP/1.4 200 OK
Charset: UTF-8
Script: \h\s0テストー。\u\s[10]テストやな。

追加データはここ

responseの各メソッドに共通するヘッダ¶

Charset: リクエストの文字コード。一番最初の行に現れるのが望ましい。
特に理由がなければUTF-8を推奨する。
互換性の問題解消のため、わざと省略される場合がある。その場合はrequestと同じ文字コードと仮定すること。
X-SSTP-PassThru-(任意の文字列): NOTIFYなどゴースト側との通信の際に、SHIORIから直接返されてきたヘッダ。
文字コード変換等最低限の処理が行われるだけで、(任意の文字列)の部分や中身はそのまま中継される。

responseのステータスコード¶

HTTPと同じく、200番台は正常受理、その他はエラー。

200 OK: 正常終了（返り値つき）
204 No Content: 正常終了（返り値なし）
210 Break: 実行はされたがスクリプト実行中にブレークされた
※EntryつきのSEND/1.xなど極めて限られた状況に限り、通常は即時200か204リターン。
400 Bad Request: リクエストに何かしらカバーしきれない不備がある
404 Not Found ※SSPのみ: ゴースト指定のSSTPで該当ゴーストがインストールや起動がされていない
408 Request Timeout: タイムアウト：ゴースト/SHIORI側と通信できない時など（普段はほぼ起こらない）
409 Conflict: \tタグなどの割り込み禁止状態か、他のリクエストの処理中
413 Payload Too Large ※SSPのみ: SSTPリクエストが長すぎて処理を拒否した
420 Refuse: ゴースト側の設定の都合で受信拒否された
500 Internal Server Error ※SSPのみ: 処理系内部で検出されたなにかしらの問題で処理しきれなかった
501 Not Implemented: 未実装のコマンドなどが含まれて処理できなかった
503 Service Unavailable: 処理系内部の都合でSSTPを受け付けられない状態
505 Version Not Supported ※SSPのみ: SSTPのバージョンがおかしい（1.0未満、3.0以上など）
512 Invisible: 最小化などでゴーストが表示されておらず、何も処理できない状態

メソッド：NOTIFY¶

ゴーストにイベントを通知するためのメソッドである。
SENDとNOTIFYは同一の処理として扱われ、機能上の差異はない。共通するヘッダの詳細やIfGhostの振り分けルールなどの仕様はメソッド：SENDを参照のこと。
Eventヘッダ＝SHIORI/3.0 IDに対応し、Reference*はそのまま引き渡される。

イベント通知のみサンプル(NOTIFY/1.0)¶

NOTIFY SSTP/1.0
Charset: UTF-8
Sender: Media Player
Event: OnMusicPlay
Reference0: 自由の翼
Reference1: Linked Horizon

ゴースト側で指定したイベントIDに反応しない場合に、「保険用の」スクリプトを指定して再生させることができる。
その際に、IfGhostヘッダを指定すると、直後にあるScriptヘッダは指定したゴースト専用のスクリプトとして扱われる。

保険反応つきサンプル(NOTIFY/1.1)¶

NOTIFY SSTP/1.1
Charset: UTF-8
Sender: Media Player
Event: OnMusicPlay
Reference0: 紅蓮の弓矢
Reference1: Linked Horizon
IfGhost: Emily,Teddy
Script: \0\s[6]その日、エミリは思い出した…\n\s[7]まだ今日は芋食べてない！\1\s[11]わざわざ今思い出したの？
IfGhost: ラーシェ,ティセ
Script: \0\s[3]巨人っていっても、身長は列車数両分しかないよね。\1\s[14]それが縦に立ち上がるとさすがに大きいと思うけどね。

request固有ヘッダ¶

Event、Reference*、Script、IfGhost、Ghostなどの共通ヘッダの詳細はメソッド：SENDを参照。

Option: SSTPで実行されるSakuraScriptや指定されたイベントがどのように扱われるかのオプションを指定する。
カンマ区切りで複数指定可能。指定する文字列のうち、NOTIFY特有分は以下の通り。
notify : イベントを強制的にNOTIFYで送る。また、保険用スクリプトはValueNotifyヘッダで返された場合と同じように強制的に扱われる。 [SSP 2.6.76]

response固有ヘッダ¶

Script: イベント通知の結果再生されたスクリプト。現在SSPのみ対応。

メソッド：SEND¶

SENDは、外部アプリケーションからゴーストにSakuraScriptやSHIORIイベントを送信し、再生させるためのメソッドである。
SENDとNOTIFYは同一の処理として扱われる。両者に機能上の差異はない。以下の仕様はNOTIFYにもそのまま適用される。
Scriptヘッダで直接SakuraScriptを指定する方法と、Eventヘッダでイベントを送信しSHIORI応答でスクリプトを得る方法の両方が使用できる。
EventとScriptは併用可能で、Eventに対するSHIORI応答がスクリプトを返さなかった場合、Scriptヘッダのスクリプトにフォールバックする。
対象ゴーストが未指定の場合、現在起動中のゴーストが対象となる。

基本的なスクリプト再生サンプル¶

SEND SSTP/1.4
Charset: UTF-8
Sender: SampleApp
Script: \h\s[0]こんにちは。\w5\u\s[10]ご機嫌いかが？\e

イベント送信サンプル¶

SEND SSTP/1.4
Charset: UTF-8
Sender: SampleApp
Event: OnExternalEvent
Reference0: param1
Reference1: param2

イベント＋フォールバックスクリプトサンプル¶

SEND SSTP/1.4
Charset: UTF-8
Sender: SampleApp
Event: OnCustomEvent
Reference0: data
Script: \h\s[0]イベント未対応時のスクリプト\e

IfGhostヘッダを複数回記述し、対応するScriptヘッダと組み合わせることで、ゴーストごとに異なるスクリプトを指定できる。

IfGhostによる振り分けサンプル¶

SEND SSTP/1.4
Charset: UTF-8
Sender: SampleApp
Script: \h\s[0]こんにちは。\e
IfGhost: まゆら
Script: \h\s[0]まゆらさん、こんにちは。\e
IfGhost: 花ちゃん,妹
Script: \h\s[0]花ちゃんと妹さん、こんにちは。\e

割り込み抑制付きサンプル¶

SEND SSTP/1.4
Charset: UTF-8
Sender: SampleApp
Script: \h\s[0]割り込まないで追加。\e
Option: nobreak

request固有ヘッダ¶

Sender: 共通ヘッダだが、SEND/NOTIFYでの特殊値としてSender: Firstが使用できる。指定すると、初回起動時のゴースト（さくら）を対象にする。
SenderとUser-Agentの両方が未指定の場合、400 Bad Requestとなる。
Script: 再生するSakuraScript。
Eventヘッダと併用した場合、Eventに対するSHIORI応答がスクリプトを返さなかった場合のフォールバックとして使用される。
Entry: エントリデータ。SHIORIに渡される。
Event: SHIORIイベント名。SHIORI/3.0ではIDヘッダの指定として取り扱われる。
Reference*: イベントのReferenceヘッダ。SHIORIには文字コード変換等最低限の処理を行い、そのまま引き渡される。
IfGhost: \0側名,\1側名の書式でゴーストの名前を指定すると、直後に来たScriptヘッダを特定のゴースト専用として取り扱う。
IfGhostの直後ではないScriptヘッダが存在した場合は、IfGhostに該当しない場合のデフォルト処理用Scriptとなる。
省略した場合はどのゴーストに対しても同じScriptヘッダが再生される。
詳細な振り分けルールは後述のIfGhostによるスクリプト振り分けを参照。
Ghost: ゴースト名（descript.txtのname）で対象ゴーストを指定する。
Option: SSTPで実行されるSakuraScriptがどのように扱われるかのオプションを指定する。
カンマ区切りで複数指定可能。共通オプション(nodescript, notranslate等)に加え、SEND/NOTIFYで使用できるオプションフラグは以下の通り。
nobreak : 現在再生中のスクリプトを中断せずにキューイングする。
notify : SHIORIイベントをnotifyモード（応答不要）で送信する。また、スクリプトがValueNotifyヘッダで返された場合と同じように強制的に扱われる。 [SSP 2.6.76]

response固有ヘッダ¶

Script: 実際に再生されたスクリプト。改行は除去される。
SHIORIカスタムヘッダ: SHIORIの応答に含まれるヘッダが透過される。

IfGhostによるスクリプト振り分け¶

IfGhostヘッダを複数回記述し、対応するScriptヘッダと組み合わせることで、ゴーストごとに異なるスクリプトを指定できる。
IfGhostとScriptは出現順で対応付けられる。最初のIfGhostより前に記述されたScriptはデフォルトスクリプトとなる。

名前の照合: IfGhostが「\0側名,\1側名」形式の場合、両方の名前が一致する必要がある。
IfGhostが「\0側名」のみの場合、\0側名の一致だけで選択される。
いずれにも一致しない場合、デフォルトスクリプトが使用される。ただし、ゴースト側が「未指定SSTP拒否」設定の場合はデフォルトスクリプトも使用されない。
デフォルトゴースト扱い: 以下の名前はデフォルトゴースト（さくら）として扱われ、そのスクリプトはデフォルトスクリプトとしても機能する。
「さくら」「エミリ」「えみりぃ」

メソッド：COMMUNICATE¶

COMMUNICATEメソッドで、ゴーストに外部から任意の文字列を与えて、反応させることができます。
基本的にゴースト内部でのコミュニケートボックスを使った反応と同じになりますが、SSTPなのでゴースト側で受理されない場合があります。

単純なCOMMUNICATE(COMMUNICATE/1.1)¶

COMMUNICATE SSTP/1.1
Charset: UTF-8
Sender: User
Sentence: おはよう。

コミュニケートはSSTPサーバ同士（≒ゴースト同士）で送受信を繰り返すことができます。
SHIORI/3.0のレスポンスReference0での送信の場合は、SSTP送信タイミングはSakuraScriptを再生し終わった時となります。
これを用いて、同時起動しているゴースト同士が会話しているような処理を組むことが可能となります。

ゴースト間コミュニケート(COMMUNICATE/1.2)¶

COMMUNICATE SSTP/1.2
Charset: UTF-8
Sender: Emily
HWnd: 28236
Sentence: \0\s[5]ちゃっらーん！エミリでーす！\nボクのお腹にはまだ若干の余裕が…？\1\s[11]そんなこと言ってたらまた太るよ？
Surface: 5,11
Reference0: 芋ちょうだい
Reference1: たくさんちょうだい
Reference2: 今すぐちょうだい

request固有ヘッダ¶

Reference*: コミュニケートの拡張情報。SHIORI/3.0ではReference2以降に格納される。SSTP Reference0 = SHIORI Reference2。
Surface: 送信元ゴーストのコミュニケート送信時点（≒スクリプト実行終了時点）での\0と\1のサーフィス番号。
OnCommunicateイベントでSurfaceヘッダとして渡される。
Option: [旧仕様]substituteを指定すると、Sentenceの内容を\1が喋る。 ※SSP未実装

メソッド：EXECUTE¶

EXECUTEメソッドで、ゴーストの各種情報取得や、SakuraScriptによらない各種コマンド実行などを行うことができます。
このメソッドの実行では、ゴーストは喋りませんが、内部状態が書き換わる可能性があります。

EXECUTEサンプル¶

EXECUTE SSTP/1.1
Charset: UTF-8
Sender: SSTPクライアント
Command: GetName

request固有ヘッダ¶

Command または Command[param1,param2...]: 実行すべきコマンド。実行する内容と返ってくる情報は後述。
大かっこ以降は実行すべきコマンドに渡すパラメータを指定する。
Reference* [SSP]: 大かっこ指定の代わりにReference0～のヘッダでパラメータを指定することもできる。

Commandヘッダに指定できる文字列と、responseの「追加データ」で返ってくる結果については、下記を参照してください。

Commandヘッダに指定できるコマンドと、返ってくる追加データ¶

GetName: 起動中のゴーストの (\0名),(\1名) カンマ区切り
GetNames [SSP]: 現在インストールされている\0名のリスト。改行区切り。空行で終端。
GetFMO [SSP 2.5.57] [リモート制限あり]: FMOの中身と同等の情報を取得する。
ただしSSTPで通信したアプリケーション内部での管理分に限り、同時実行中のアプリケーション群共用である本来のFMOとは異なる。
主にウインドウを持たずDirect SSTPを送信できないコンソールアプリなどで、Socket SSTPのみでReceiverGhostHWndヘッダを活用しDirect SSTP相当の機能を実現するために用いられる。
改行区切り、空行で終端。
リモートからの要求の場合は、各パス情報が抜け、ヘッダとhwndがダミーに置き換わる。
GetGhostName [SSP]: 起動中のゴースト本体の名前(descript.txtのname)
GetShellName [SSP]: 起動中のゴーストの現在使用中のシェルの名前
GetBalloonName [SSP]: 起動中のゴーストの現在使用中のバルーンの名前
GetVersion: ベースウェア(実行中のソフト)のバージョン
GetGhostNameList [SSP 2.6.53]: SSPで認識している全ゴーストの名前(descript.txtのname)の改行区切りリスト
GetShellNameList [SSP 2.6.53]: 起動中のゴーストで認識している全シェルの名前(descript.txtのname)の改行区切りリスト
GetBalloonNameList [SSP 2.6.53]: SSPで認識している全バルーンの名前(descript.txtのname)の改行区切りリスト
GetHeadlineNameList [SSP 2.6.53]: SSPで認識している全ヘッドラインの名前(descript.txtのname)の改行区切りリスト
GetPluginNameList [SSP 2.6.53]: SSPで認識している全プラグインの名前(descript.txtのname)の改行区切りリスト
GetShortVersion [SSP 2.6.53]: ベースウェア(実行中のソフト)のバージョン(ピリオド区切りのバージョン番号のみ)
version.jsonのssp.full.versionなどと単純比較すると最新版かどうかチェックできる
GetStatus [SSP 2.8.94]: 起動中のゴーストの現在の実行状態。SHIORI/3.0 requestのStatusヘッダや、プロパティシステムのcurrentghost.statusと同じ内容。
複数の状態に当てはまる場合はカンマ区切り。各値の意味は※SHIORI Statusヘッダを参照。
どの状態にも当てはまらない場合は追加データなし(ステータスコード200)
Quiet [リモート不可]: Restoreを実行するか、16秒間が経過するまで黙る。追加データなし(ステータスコード200番台で成功)
Restore: Quietを解除。追加データなし(ステータスコード200番台で成功)
CompressArchive [SSP 2.7.23] [リモート不可]: 指定したフォルダ内のファイル群をZIPファイルに圧縮する。
パラメータ0：圧縮ファイル名(フルパスで指定、相対パス指定不可)
パラメータ1：圧縮すべきフォルダのフルパス
パラメータ2以降：オプション(省略可)
オプションは以下の通り。
--event=イベント識別子……イベント識別子を指定すると、レスポンス後に圧縮を続け、終わり次第イベントが起きる。識別子がOnではじまる場合はその識別子のイベントが発生し、それ以外の場合はOnCompressArchiveCompleteまたはOnCompressArchiveFailureが発生する。省略時は処理が完了するまでレスポンスが返らない。
--password=パスワード……指定したパスワードを使用してAES暗号化ZIPを有効にする。
動作後のイベントに関する仕様はOnCompressArchiveComplete・OnCompressArchiveFailureを参照。
[SSP 2.9.25] SAORI over DirectSSTPからは、internal_fileのCompressArchiveでも呼べる（相対パス指定や/区切りも書ける）。
セキュリティ上の観点から、圧縮先は、SSP管理下のフォルダ(ghostフォルダ、balloonフォルダなど「フォルダ」設定で指定した場所)以下への展開に制限される。
また、この制限は適宜強化される可能性があるため、ゴースト自身のデータが置かれているフォルダ以下に限定するのが無難。
追加データなし(ステータスコード200番台で成功)
ExtractArchive [SSP 2.7.23] [リモート不可]: 指定したZIPファイルを解凍する。
パラメータ0：圧縮ファイル名(フルパスで指定、相対パス指定不可)
パラメータ1：解凍先のフォルダのフルパス
パラメータ2以降：オプション(省略可)
オプションは以下の通り。
--event=イベント識別子……イベント識別子を指定すると、レスポンス後に解凍を続け、終わり次第イベントが起きる。識別子がOnではじまる場合はその識別子のイベントが発生し、それ以外の場合はOnExtractArchiveCompleteまたはOnExtractArchiveFailureが発生する。省略時は処理が完了するまでレスポンスが返らない。
--password=パスワード……指定したパスワードを使用してパスワード問い合わせなしで展開する。
動作後のイベントに関する仕様はOnExtractArchiveComplete・OnExtractArchiveFailureを参照。
[SSP 2.9.25] SAORI over DirectSSTPからは、internal_fileのExtractArchiveでも呼べる（相対パス指定や/区切りも書ける）。
セキュリティ上の観点から、解凍先は、SSP管理下のフォルダ(ghostフォルダ、balloonフォルダなど「フォルダ」設定で指定した場所)以下への展開に制限される。
また、この制限は適宜強化される可能性があるため、ゴースト自身のデータが置かれているフォルダ以下に限定するのが無難。
追加データなし(ステータスコード200番台で成功)
DumpSurface [SSP 2.5.98] [リモート不可]: 合成済みのサーフェス画像を指定したディレクトリに出力する。パラメータは\![execute,dumpsurface]と同じ。
ただしイベントIDは指定できず、ディレクトリ・スコープID・サーフェスリスト・prefix・ゼロ位置切り出し・アニメーションID [SSP 2.9.05] の順に指定する。
[SSP 2.9.08] SakuraScript版と同じく、--dir= / --scope= / --surface= / --prefix= / --fromzero= / --animation= の形式でも順不同で指定でき、上記の順による指定と混在してもよい（--で始まらないパラメータは、現れた順に上記の順で割り当てられる）。ディレクトリ以外は省略でき、スコープIDの省略時は0になる。--event=は無視される。
DumpSurface[...]の形式ではパラメータ中にカンマを書けないため、カンマを含むサーフェスリストはReference0以降で指定すること。
処理が終わるまでレスポンスが返らないので注意。
追加データなし(ステータスコード200番台で成功)
MoveAsync [SSP] [リモート不可]: \![moveasync]と同じことをSakuraScriptを介さずに実行する。パラメータ指定方法はSakuraScript版と同じ。
SSTPのタイムアウトまでにresponseを返せないのとデッドロックの原因になるため、asyncなしのmoveは実行できない。
追加データなし(ステータスコード200番台で成功)
SetTrayIcon [SSP] [リモート不可]: \![set,tasktrayicon]と同じことをSakuraScriptを介さずに実行する。パラメータ指定方法はSakuraScript版と同じ。
追加データなし(ステータスコード200番台で成功)
SetTrayBalloon [SSP] [リモート不可]: \![set,trayballoon]と同じことをSakuraScriptを介さずに実行する。パラメータ指定方法はSakuraScript版と同じ。
追加データなし(ステータスコード200番台で成功)
SetProperty [SSP] [リモート不可]: プロパティシステムに値を書き込む。
パラメータ0：プロパティの名前
パラメータ1：設定すべき値
追加データなし(ステータスコード200番台で成功)
GetProperty [SSP]: プロパティシステムから値を読み出す。
パラメータ0：プロパティの名前
追加データは取得したプロパティの値。
SetCookie: Senderで指定したクライアント名ごとに保存される、汎用データ保存領域に書き込む。
ブラウザの「クッキー」と同様の使い方を想定している。
パラメータ0：クッキーの名前
パラメータ1：設定すべき値
追加データなし(ステータスコード200番台で成功)
GetCookie: Senderで指定したクライアント名ごとに保存される、汎用データ保存領域から読み出す。
パラメータ0：クッキーの名前
追加データは取得したクッキーの値。

メソッド：GIVE¶

[旧仕様] ゴーストに各種データを与え、処理したり反応させたりするためのメソッドです。
相当昔の仕様であり、現在これを使用する意味はありません。NOTIFYやCOMMUNICATEを使用してください。

requestサンプル¶

GIVE SSTP/1.1
Charset: UTF-8
Sender: SSTPクライアント
Document: まず水や。それから粉やな。

GIVE SSTP/1.1
Charset: UTF-8
Sender: SSTPクライアント
Song: 佐世保の時雨

request固有ヘッダ¶

Document: 文書（汎用的な文字列）
SHIORI/3.0ではユーザーコミュニケートと同じ扱いとなり、OnCommunicateイベントが発生する。
Song: 歌の名前。
SHIORI/3.0ではOnMusicPlayイベントが発生し、Reference0がSongヘッダに指定された文字列となる。