{
  "version": 13,
  "name": "19_secrets",
  "description": "Example: a project secret. $demoKey is a secret of this project (secrets.json holds only its name). Adding the Examples project gives it a demo value, encrypted on this computer; change it in Secrets (the lock in the title bar). The value is sent in a header and a query parameter; httpbin echoes both back, the checks compare them with the real value, and the log, the report and Response details show •••••• instead.",
  "tags": [
    "example",
    "secrets",
    "security"
  ],
  "globals": [
    {
      "name": "$baseUrl",
      "value": "https://httpbin.org"
    }
  ],
  "globalFunctions": "// Assertion helpers, built on check(label, pass, details).\n// Each records a pass / fail line in the log and the report.\n// A failed one fails its step when the step is done;\n// the code keeps running. Change them or add your own.\n// r defaults to the last response.\n\nfunction assertTrue(value, label = \"is true\") {\n  return check(label, Boolean(value), { actual: value, expected: true });\n}\n\nfunction assertEqual(actual, expected, label = \"equals \" + JSON.stringify(expected)) {\n  return check(label, isEqual(actual, expected), { actual, expected });\n}\n\nfunction assertNotEqual(actual, unexpected, label = \"does not equal \" + JSON.stringify(unexpected)) {\n  return check(label, !isEqual(actual, unexpected), { actual, expected: \"not \" + JSON.stringify(unexpected) });\n}\n\n// text contains a part, or a list contains an item\nfunction assertContains(haystack, needle, label = \"contains \" + JSON.stringify(needle)) {\n  const pass = Array.isArray(haystack) ? haystack.some((x) => isEqual(x, needle)) : String(haystack).includes(needle);\n  return check(label, pass, { actual: haystack, expected: needle });\n}\n\nfunction assertMatch(text, regex, label = \"matches \" + regex) {\n  return check(label, new RegExp(regex).test(String(text)), { actual: text, expected: String(regex) });\n}\n\nfunction assertLessThan(actual, limit, label = \"< \" + limit) {\n  return check(label, Number(actual) < Number(limit), { actual, expected: \"< \" + limit });\n}\n\nfunction assertGreaterThan(actual, limit, label = \"> \" + limit) {\n  return check(label, Number(actual) > Number(limit), { actual, expected: \"> \" + limit });\n}\n\n// expected: 200, \"2xx\", or a list such as [200, 201]\nfunction assertStatus(expected, r = response) {\n  const list = [].concat(expected).map(String);\n  const status = String(r && r.status);\n  const pass = list.some((e) => e === status || (/^[1-5]xx$/i.test(e) && e[0] === status[0]));\n  return check(\"status is \" + list.join(\" or \"), pass, { actual: r && r.status, expected });\n}\n\nfunction assertTimeBelow(ms, r = response) {\n  return check(\"time < \" + ms + \" ms\", Boolean(r) && r.timeMs < ms, { actual: r && r.timeMs, expected: \"< \" + ms });\n}\n\n// without expected, the header only has to exist\nfunction assertHeader(name, expected, r = response) {\n  const value = r ? r.headers[String(name).toLowerCase()] : undefined;\n  if (expected === undefined) return check(\"header \" + name + \" exists\", value !== undefined, { actual: value });\n  return check(\"header \" + name + \" equals \" + expected, String(value) === String(expected), { actual: value, expected });\n}\n\n// e.g. assertJsonPath(\"$.items[0].id\", 42); without expected, the value only has to exist\nfunction assertJsonPath(path, expected, r = response) {\n  const value = jsonPath(path, r);\n  if (expected === undefined) return check(path + \" exists\", value !== undefined, { actual: value });\n  return check(path + \" equals \" + JSON.stringify(expected), isEqual(value, expected), { actual: value, expected });\n}\n\n// schema: a JSON Schema object\nfunction assertSchema(schema, r = response) {\n  const result = validateSchema(r, schema);\n  return check(\"matches the JSON Schema\", result.valid, { error: result.errors || undefined });\n}\n",
  "libraries": [],
  "activeEnvironment": "",
  "auth": {
    "type": "none"
  },
  "settings": {},
  "data": {
    "file": ""
  },
  "cookies": [],
  "steps": [
    {
      "id": "send-key",
      "type": "request",
      "name": "Send the key in a header and the query",
      "method": "GET",
      "url": "$baseUrl/anything",
      "params": [
        {
          "name": "key",
          "value": "$demoKey"
        }
      ],
      "headers": [
        {
          "name": "X-Api-Key",
          "value": "$demoKey"
        }
      ],
      "checks": [
        {
          "target": "status",
          "op": "equals",
          "value": "200"
        },
        {
          "target": "json",
          "path": "$.headers['X-Api-Key']",
          "op": "equals",
          "value": "$demoKey"
        },
        {
          "target": "json",
          "path": "$.args.key",
          "op": "equals",
          "value": "$demoKey"
        }
      ]
    },
    {
      "id": "auth-key",
      "type": "request",
      "name": "The same key through Auth → API key",
      "method": "GET",
      "url": "$baseUrl/headers",
      "auth": {
        "type": "apikey",
        "name": "X-Api-Key",
        "value": "$demoKey",
        "in": "header"
      },
      "checks": [
        {
          "target": "status",
          "op": "equals",
          "value": "200"
        },
        {
          "target": "json",
          "path": "$.headers['X-Api-Key']",
          "op": "equals",
          "value": "$demoKey"
        }
      ]
    },
    {
      "id": "in-code",
      "type": "code",
      "name": "Code sees the real value; the log never does",
      "code": "// Code gets the real value. Anything that reaches the log is masked,\n// also copies of the value in other strings.\nconst copy = \"key=\" + $demoKey;\nlog(\"The key has \" + $demoKey.length + \" characters. Logged as: \" + copy);\nassertTrue($demoKey.length > 0, \"the secret has a value\");"
    }
  ]
}
