Changes between Initial Version and Version 1 of ApiCertInfo

Timestamp:

Aug 16, 2017, 11:33:07 AM (7 years ago)

Author:

alx

Comment:

--

ApiCertInfo

@@ +1 @@
+=  Команда certinfo  =
+
+== Назначение команды ==
+
+Команда `certinfo` возвращает информацию о текущем сертификате SSL, установленном для сервера HTTPS.
+
+== Ключи запроса ==
+
+||  '''Ключ'''  ||  '''Тип значения'''  ||  '''обязательный'''  ||  '''Описание'''  ||
+||  cmd  ||  строка  ||  да  || "certinfo" - имя команды ||
+
+=== Пример запроса ===
+
+ `{"cmd":"certinfo"}`
+
+== Права доступа ==
+
+Для выполнения команды `certinfo` не требуется наличия каких-либо прав.
+
+== Возвращаемые данные ==
+
+В случае отсутствия установленного сертификата SSL команда `certinfo` возвращает ключ `certinfo`, значением которого является строка "нет сертификата":
+
+ `{"cmd":"certinfo","certinfo":"нет сертификата"}`
+
+При наличии сертификата команда `certinfo` возвращает ключ `certinfo`, значением которого является объект (хэш), содержащий следующие ключи:
+
+||  '''Ключ'''  ||  '''Тип значения'''  ||  '''Описание'''  ||
+||  subject  ||  строка  || поле "Subject" сертификата или текстовое сообщение об ошибке если поле "Subject" получить не удалось ||
+||  issuer  ||  строка  || поле "Issuer" сертификата или текстовое сообщение об ошибке если поле "Issuer" получить не удалось ||
+||  notBefore  ||  строка  || поле "!NotBefore" сертификата - время, начиная с которого сертификат валиден ||
+||  notAfter  ||  строка  || поле "!NotAfter" сертификата - время, до которого сертификат валиден ||
+||  serial  ||  строка  || серийный номер сертификата ||
+
+Пример ответа на команду `certinfo` при наличии сертификата:
+
+{{{
+{
+  "cmd":"certinfo",
+  "certinfo": {
+    "subject":"/CN=192.168.0.69/O=ADC",
+    "issuer":"/CN=ADC CA/O=ADC",
+    "notBefore":"Sep 25 12:48:04 2014 GMT",
+    "notAfter":"Sep 23 12:48:04 2020 GMT",
+    "serial":"8429CE11D6C03201"
+  }
+}
+}}}