Reference: SHIORI/3.0 (External site) SHIORI/2.x (External site)
The implementation support status of extension headers is notified at the beginning of SHIORI execution using ID: capability.
GET SHIORI/3.0 Charset: UTF-8 Sender: SSP SenderType: internal,raise SecurityLevel: local Status: choosing,balloon(0=0) ID: OnFirstBoot BaseID: OnBoot Reference0: 1
※The line feed code is CR+LF
※Terminate with a blank line ((CR+LF)x2 at the end of the last line).
Character code. Preferably before the first line, or at least before any line whose character code is not in the ASCII range.
Event source.
Attributes of the event source. The following attributes are used. If there is more than one, they are connected by commas.
For ID: OnTranslate, the attributes of the translate-source event are inherited.
Security level when executing the script. One of the following.
For ID: OnTranslate, the attributes of the translate-source event are inherited.
In the case of external, it is a notification from outside the running system, so it should be handled with caution for security reasons.
The concept is different from internal/external of SenderType. Even if the event is generated from outside the application, it will be judged as local if it can be regarded as safe, so the SecurityLevel may be local even if the SenderType is external.
A URL-like string indicating the source server. The format is as follows. The concept is the same as that of Origin in HTTP headers.
SecurityOrigin: null
SecurityOrigin: <scheme>://<hostname>
SecurityOrigin: <scheme>://<hostname>:<port>
scheme is usually http, https, or sstp. hostname is the name or IP of the source server. port is the port on which replies can be accepted.
It will be null if there is no information, such as when a header is not specified in SSTP, etc.
See also SecurityOrigin in the SSTP specification.
Ghost running state. As follows. If there is more than one, they are connected by commas.
Event name or resource identifier
Compatible base event names.
Example: Since OnFirstBoot is compatible with OnBoot, and OnFirstBoot is a variant of OnBoot, OnFirstBoot's BaseID will contain OnBoot.
Additional information accompanying the event. A number is included after Reference. The number of lines is unlimited (as long as memory allows).
If and only if an event notification is received from SSTP, the SSTP request header beginning with "X-SSTP-PassThru-" will be notified as is.
Not added when it is not SSTP.
SHIORI/3.0 200 OK Charset: UTF-8 Sender: AYA Value: \1\s[10]\0\s[0]\e
※The line feed code is CR+LF
※Terminate with a blank line ((CR+LF)x2 at the end of the last line).
As with HTTP, the number 200 indicates success, while the others indicate some kind of failure (error).
Currently, the following are primarily used.
Character code. Preferably before the first line, or at least before any line whose character code is not in the ASCII range.
Sender. Usually the name of the SHIORI.
Script to be spoken.
[Experimental feature]
Extension for executing SakuraScript even when the request method is NOTIFY.
If SakuraScript is returned with this header, it is executed immediately. In the case of GET, it is executed before the script in the Value header is executed.
The number of tags that can be executed is extremely limied; all other tags and strings are ignored.
It is ignored when the method is not NOTIFY or if the Value header is already present. Restriction removed in 2.6.76.
Currently, the following tags can be executed:
One of the following.
SecurityLevel of the script to be spoken. If it is external, some scripts will not be able to be executed due to security features.
String to be displayed on the balloon marker (additional information on the underside of the ballon).
The level of error that occurred inside the SHIORI. One of the following. To express multiple errors, separate them with a byte value of 1.
If this header is present, the user is notified that an error has occurred.
The level of notification is user-configurable. Usually, it is error or higher.
In the case of SSP, it is recorded in the error log and an error icon appears in the notification area.
Detailed information on errors that occurred inside the SHIORI. Valid only if ErrorLevel is present.
To express multiple errors, separate them with a byte value of 1
The number of elements in ErrorLevel and ErrorDescription must be the same.
Offset value (X,Y) of the balloon.
Name of the \0 side of the ghost if you want to send a communication.
Additional information for communication.
Reference1 in response = Reference0 in SSTP communicate = Reference2 in the receiver's OnCommunicate.
Note that the above is out of alignment due to compatibility issues.
Number of generations of communication. 0 for the first time, +1 for each successive exchange.
Although it is an SSP extension, it is actually SHIORI/2.x compatible processing.
A balloon marker string that you want to display "to the other side" while communicating.
Sent as a Marker header of SSTP.
If and only if an event notification is received from SSTP, this header is added to the SSTP response as it is.
Not added when it is not SSTP.
Multiple headers can be specified, but if you want to return more than one, change the header name.
(Old header name: X-SSTP-Return- , will be deprecated.)