SSTP/1.x
参考：SSTP （外部サイト）
現在のところDirectSSTPについてはWindowsの仕様に大きく依存しており、他OSでの実装を想定していません。
Ukadoc Project までご連絡ください。
概要
SSTPはゴースト間の汎用通信仕様です。単純なSakuraScriptの再生や、外部からのイベント通知等に使えます。
IANAのPort number registry には7743と9801番が登録されていますが、実運用されているのは9801番のみです。
Direct SSTP
Direct SSTPはOSに強く依存したIPCの仕組みを利用した通信仕様です。プロトコル仕様は(Socket) SSTPと同じですが、比較的処理が重いTCP/IPを使用せず、直接ゴーストを指定して軽量な通信を行うことを目的としています。
WM_COPYDATA をSendMessage系関数で送信(Postは不可)
FMOから取得
COPYDATASTRUCT へのポインタ
SSTP over HTTP
SSTP over HTTPは、SSP 2.6.32で実装された、HTTPリクエストメッセージボディにSSTPリクエストをそのまま突っ込み、HTTPレスポンスボディにSSTPレスポンスがそのまま返ってくるきわめて単純な仕組みです。
お試し
既存のjsライブラリ は、jsでSSTP over HTTPを行うために使用できます。
注意：Originヘッダがlocalhostを指していない場合は、強制的にリモートアドレスからのSSTPリクエストとして扱われ、SakuraScriptタグや実行できるSSTPメソッドに強い制約がかかり、かつSecurityLevelヘッダも無視されます。
request/response
SHIORIなど他のプロトコルと同じく、HTTPに似せた独自プロトコルです。
改行コードは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
リクエストの文字コード。一番最初の行に現れるのが望ましい。
Sender
送信者を示す文字列。「SSTP送信ツール」など。COMMUNICATEメソッドの場合は、送信元のゴースト\0名。
SecurityLevel
SHIORIやSakuraScriptで処理する際のセキュリティレベルの指定。local/externalのいずれか。
SecurityOrigin [SSP 2.6.59]
送信元サーバを示すURL風の文字列。以下の形式となる。HTTPヘッダのOrigin と考え方は同じ。
Option
SSTPで実行されるSakuraScriptがどのように扱われるかのオプションを指定する。
ID
"Owned SSTP"と呼ばれるもの。SHIORI uniqueid で送られてきたIDか、FMOの識別ID(SSPのみ) を指定すると、各種セキュリティチェックやロック等を無視して、本SSTPをゴースト内部での処理と同じ優先度で扱う。
X-SSTP-PassThru-(任意の文字列)
NOTIFYなどゴースト側との通信の際に、SHIORIに直接渡されるヘッダ。
HWnd
DirectSSTP限定で、responseを返信すべきウインドウハンドルを示す。
ReceiverGhostHWnd [SSP 2.5.57]
(Socket)SSTP限定で、requestを送るべきゴーストの\0のウインドウハンドルを示す。
ReceiverGhostName [SSP 2.5.57]
(Socket)SSTP限定で、requestを送るべきゴーストの\0名を示す。
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
リクエストの文字コード。一番最初の行に現れるのが望ましい。
X-SSTP-PassThru-(任意の文字列)
NOTIFYなどゴースト側との通信の際に、SHIORIから直接返されてきたヘッダ。
responseのステータスコード
HTTPと同じく、200番台は正常受理、その他はエラー。
200 OK
正常終了（返り値つき）
204 No Content
正常終了（返り値なし）
210 Break
実行はされたがスクリプト実行中にブレークされた
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/1.0)
NOTIFY SSTP/1.0
Charset: UTF-8
Sender: Media Player
Event: OnMusicPlay
Reference0: 自由の翼
Reference1: Linked Horizon
ゴースト側で指定したイベントIDに反応しない場合に、「保険用の」スクリプトを指定して再生させることができる。
保険反応つきサンプル(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や指定されたイベントがどのように扱われるかのオプションを指定する。
ValueNotifyヘッダで返された場合 と同じように強制的に扱われる。 [SSP 2.6.76]
response固有ヘッダ
Script
イベント通知の結果再生されたスクリプト。現在SSPのみ対応。
メソッド：SEND
SENDは、外部アプリケーションからゴーストにSakuraScriptやSHIORIイベントを送信し、再生させるためのメソッドである。
基本的なスクリプト再生サンプル
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が使用できる。指定すると、初回起動時のゴースト（さくら）を対象にする。
Script
再生するSakuraScript。
Entry
エントリデータ。SHIORIに渡される。
Event
SHIORIイベント名。SHIORI/3.0ではIDヘッダの指定として取り扱われる。
Reference*
イベントのReferenceヘッダ。SHIORIには文字コード変換等最低限の処理を行い、そのまま引き渡される。
IfGhost
\0側名,\1側名 の書式でゴーストの名前を指定すると、直後に来たScriptヘッダを特定のゴースト専用として取り扱う。
IfGhostによるスクリプト振り分け を参照。
Ghost
ゴースト名（descript.txtのname）で対象ゴーストを指定する。
Option
SSTPで実行されるSakuraScriptがどのように扱われるかのオプションを指定する。
ValueNotifyヘッダで返された場合 と同じように強制的に扱われる。 [SSP 2.6.76]
response固有ヘッダ
Script
実際に再生されたスクリプト。改行は除去される。
SHIORIカスタムヘッダ
SHIORIの応答に含まれるヘッダが透過される。
IfGhostによるスクリプト振り分け
IfGhostヘッダを複数回記述し、対応するScriptヘッダと組み合わせることで、ゴーストごとに異なるスクリプトを指定できる。
名前の照合
IfGhostが「\0側名,\1側名」形式の場合、両方の名前が一致する必要がある。
デフォルトゴースト扱い
以下の名前はデフォルトゴースト（さくら）として扱われ、そのスクリプトはデフォルトスクリプトとしても機能する。
メソッド：COMMUNICATE
COMMUNICATEメソッドで、ゴーストに外部から任意の文字列を与えて、反応させることができます。
単純なCOMMUNICATE(COMMUNICATE/1.1)
COMMUNICATE SSTP/1.1
Charset: UTF-8
Sender: User
Sentence: おはよう。
コミュニケートはSSTPサーバ同士（≒ゴースト同士）で送受信を繰り返すことができます。
ゴースト間コミュニケート(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のサーフィス番号。
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 の中身と同等の情報を取得する。
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などと単純比較すると最新版かどうかチェックできる
Quiet [リモート不可]
Restoreを実行するか、16秒間が経過するまで黙る。追加データなし(ステータスコード200番台で成功)
Restore
Quietを解除。追加データなし(ステータスコード200番台で成功)
CompressArchive [SSP 2.7.23] [リモート不可]
指定したフォルダ内のファイル群をZIPファイルに圧縮する。
OnCompressArchiveComplete ・OnCompressArchiveFailure を参照。
ExtractArchive [SSP 2.7.23] [リモート不可]
指定したZIPファイルを解凍する。
OnExtractArchiveComplete ・OnExtractArchiveFailure を参照。
DumpSurface [SSP 2.5.98] [リモート不可]
合成済みのサーフェス画像を指定したディレクトリに出力する。パラメータは\![execute,dumpsurface] と同じ。
MoveAsync [SSP] [リモート不可]
\![moveasync] と同じことをSakuraScriptを介さずに実行する。パラメータ指定方法はSakuraScript版と同じ。
SetTrayIcon [SSP] [リモート不可]
\![set,tasktrayicon] と同じことをSakuraScriptを介さずに実行する。パラメータ指定方法はSakuraScript版と同じ。
SetTrayBalloon [SSP] [リモート不可]
\![set,trayballoon] と同じことをSakuraScriptを介さずに実行する。パラメータ指定方法はSakuraScript版と同じ。
SetProperty [SSP] [リモート不可]
プロパティシステム に値を書き込む。
GetProperty [SSP]
プロパティシステム から値を読み出す。
SetCookie
Senderで指定したクライアント名ごとに保存される、汎用データ保存領域に書き込む。
GetCookie
Senderで指定したクライアント名ごとに保存される、汎用データ保存領域から読み出す。
メソッド：GIVE
[旧仕様] ゴーストに各種データを与え、処理したり反応させたりするためのメソッドです。
requestサンプル
GIVE SSTP/1.1
Charset: UTF-8
Sender: SSTPクライアント
Document: まず水や。それから粉やな。
GIVE SSTP/1.1
Charset: UTF-8
Sender: SSTPクライアント
Song: 佐世保の時雨
request固有ヘッダ
Document
文書（汎用的な文字列）
Song
歌の名前。