diff --git a/.phrozn/entries/serverapi.twig b/.phrozn/entries/serverapi.twig index ed61bed..5fc7355 100755 --- a/.phrozn/entries/serverapi.twig +++ b/.phrozn/entries/serverapi.twig @@ -82,10 +82,11 @@ The following parameters are sent in all POST requests from KalSMS:
"version" ::= <integer>
- The API version of the POST requests (currently "2"). + KalSMS's version code. This is an integer that will be incremented whenever + a new version of KalSMS is released. (It is not the same as the version name shown + on the Help screen.)

- This number will be incremented whenever the format of POST requests changes significantly. This allows the server to support phones running different API versions at the same time. If a deployment has many phones running with KalSMS, the server should update its code first, then the phones can be upgraded to the new version of KalSMS as convenient. @@ -130,15 +131,16 @@ The following HTTP Headers are sent in all POST requests from KalSMS:
"X-Kalsms-Signature" ::= <text>
- A signature of the request to verify the phone and the server share the same password - (though it doesn't protect against MITM snooping or replay attacks). + A signature of the request to verify the phone and the server share the same password. + (This doesn't protect against MITM snooping or replay attacks, so it is recommended to + use the https:// protocol.)

The signature is calculated by the following algorithm:
    -
  1. Sort all POST parameters (not including file uploads) - in alphabetical order by the name of the field.
  2. +
  3. Sort all POST parameters, not including file uploads, + by the name of the field (in the usual ASCII order).
  4. Generate an input string by concatenating:
      diff --git a/serverapi.html b/serverapi.html index 911fb79..ea6dfdb 100755 --- a/serverapi.html +++ b/serverapi.html @@ -114,10 +114,11 @@ The following parameters are sent in all POST requests from KalSMS:
      "version" ::= <integer>
      - The API version of the POST requests (currently "2"). + KalSMS's version code. This is an integer that will be incremented whenever + a new version of KalSMS is released. (It is not the same as the version name shown + on the Help screen.)

      - This number will be incremented whenever the format of POST requests changes significantly. This allows the server to support phones running different API versions at the same time. If a deployment has many phones running with KalSMS, the server should update its code first, then the phones can be upgraded to the new version of KalSMS as convenient. @@ -162,15 +163,16 @@ The following HTTP Headers are sent in all POST requests from KalSMS:
      "X-Kalsms-Signature" ::= <text>
      - A signature of the request to verify the phone and the server share the same password - (though it doesn't protect against MITM snooping or replay attacks). + A signature of the request to verify the phone and the server share the same password. + (This doesn't protect against MITM snooping or replay attacks, so it is recommended to + use the https:// protocol.)

      The signature is calculated by the following algorithm:
        -
      1. Sort all POST parameters (not including file uploads) - in alphabetical order by the name of the field.
      2. +
      3. Sort all POST parameters, not including file uploads, + by the name of the field (in the usual ASCII order).
      4. Generate an input string by concatenating: