endpoint_scaninfo.txt 3.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384
  1. THE SCANINFO ENDPOINT
  2. Endpoint: /api/v1/cfssl/scaninfo
  3. Method: GET
  4. Result:
  5. The returned result is a JSON object with keys for each scan family. For
  6. each family, there exists a `description` containing a string describing the
  7. family and a `scanners` object mapping each of the family's scanners to
  8. an object containing a `description` string.
  9. Example:
  10. $ curl ${CFSSL_HOST}/api/v1/cfssl/scaninfo | python -m json.tool
  11. % Total % Received % Xferd Average Speed Time Time Time Current
  12. Dload Upload Total Spent Left Speed
  13. 100 1412 100 1412 0 0 391k 0 --:--:-- --:--:-- --:--:-- 459k
  14. {
  15. "errors": [],
  16. "messages": [],
  17. "result": {
  18. "Broad": {
  19. "description": "Large scale scans of TLS hosts",
  20. "scanners": {
  21. "IntermediateCAs": {
  22. "description": "Scans a CIDR IP range for unknown Intermediate CAs"
  23. }
  24. }
  25. },
  26. "Connectivity": {
  27. "description": "Scans for basic connectivity with the host through DNS and TCP/TLS dials",
  28. "scanners": {
  29. "CloudFlareStatus": {
  30. "description": "Host is on CloudFlare"
  31. },
  32. "DNSLookup": {
  33. "description": "Host can be resolved through DNS"
  34. },
  35. "TCPDial": {
  36. "description": "Host accepts TCP connection"
  37. },
  38. "TLSDial": {
  39. "description": "Host can perform TLS handshake"
  40. }
  41. }
  42. },
  43. "PKI": {
  44. "description": "Scans for the Public Key Infrastructure",
  45. "scanners": {
  46. "ChainExpiration": {
  47. "description": "Host's chain hasn't expired and won't expire in the next 30 days"
  48. },
  49. "ChainValidation": {
  50. "description": "All certificates in host's chain are valid"
  51. },
  52. "MultipleCerts": {
  53. "description": "Host serves same certificate chain across all IPs"
  54. }
  55. }
  56. },
  57. "TLSHandshake": {
  58. "description": "Scans for host's SSL/TLS version and cipher suite negotiation",
  59. "scanners": {
  60. "CipherSuite": {
  61. "description": "Determines host's cipher suites accepted and prefered order"
  62. },
  63. "SigAlgs": {
  64. "description": "Determines host's accepted signature and hash algorithms"
  65. }
  66. }
  67. },
  68. "TLSSession": {
  69. "description": "Scans host's implementation of TLS session resumption using session tickets/session IDs",
  70. "scanners": {
  71. "SessionResume": {
  72. "description": "Host is able to resume sessions across all addresses"
  73. }
  74. }
  75. }
  76. },
  77. "success": true
  78. }