QR Code Reader - goqr.me

Details

ID	`QR Code Reader - goqr.me`
Provider	Open Source
Category	Utilities
From Version	6.0.0
Docker Image	`demisto/python3:3.12.13.10116658`
Supported Modules	Agentix XSIAM

README

Read QR Code from image file.
This integration was integrated and tested with version 1.0.0 of QR Code Reader - goqr.me

Configure QR Code Reader - goqr.me in Cortex

Parameter	Required
Trust any certificate (not secure)	False

Commands

You can execute these commands from the CLI, as part of an automation, or in a playbook.
After you successfully execute a command, a DBot message appears in the War Room with the command details.

goqr-read-qr-code-from-file

Upload a PNG, GIF or JP(E)G image which is smaller than 1 MiB via the entry_id of the image file.

Base Command

goqr-read-qr-code-from-file

Input

Argument Name	Description	Required
entry_id	Entry ID of image file.	Required

Context Output

Path	Type	Description
GoQRCodeData.data	unknown	QR Code data obtained
GoQRCodeData.error	unknown	Errors reading QR code
GoQRCodeData.seq	unknown	sequence numbers read from code

Command Example

``````

Human Readable Output

Configuration parameters

insecure — Trust any certificate (not secure)

Commands (1)

goqr-read-qr-code-from-file
Upload a PNG, GIF or JP(E)G image which is smaller than 1 MiB via the entry_id of the image file.

Source

QRCodeReaderGoqrMe.py QRCodeReaderGoqrMe_test.py QRCodeReaderGoqrMe.yml QRCodeReaderGoqrMe_description.md

Download History Raw

import os
import shutil
import traceback

import demistomock as demisto  # noqa: F401
import urllib3
from CommonServerPython import *  # noqa: F401

# Disable insecure warnings
urllib3.disable_warnings()

""" CONSTANTS """

URL = "http://api.qrserver.com/"

""" FUNCTION """


def read_qr_code(verify=True):
    entry_id = demisto.args().get("entry_id")
    file_path = demisto.getFilePath(entry_id)["path"]
    file_name = os.path.basename(demisto.getFilePath(entry_id)["name"])

    try:
        try:
            shutil.copy(file_path, file_name)
        except Exception as e:
            demisto.error(f"Failed to copy file: {e}\n{traceback.format_exc()}")
            raise Exception("Failed to prepare file for upload.")

        multipart_file = {"file": open(file_name, "rb")}
        data = {"outputformat": "json"}
        res = requests.post(URL + "/v1/read-qr-code/", data=data, files=multipart_file, verify=verify)
        if str(res.status_code) == "200":
            return res
        else:
            return_error(str(res.text))

    finally:
        if os.path.exists(file_name):
            demisto.debug(f"Removing temporary file: {file_name}")
            os.remove(file_name)
        else:
            demisto.debug(f"Temporary file not found, skipping removal: {file_name}")


def test_qr_api(verify=True):
    res = requests.get(URL + "/v1/create-qr-code/?data=HelloWorld", verify)
    if str(res.status_code) == "200":
        return "ok"
    else:
        return str(res.text)


""" MAIN FUNCTION """


def main() -> None:
    verify_certificate = not demisto.params().get("insecure", False)

    if demisto.command() == "test-module":
        # This is the call made when pressing the integration Test button.
        result = test_qr_api(verify=verify_certificate)
        demisto.results(result)

    elif demisto.command() == "goqr-read-qr-code-from-file":
        res = read_qr_code(verify=verify_certificate)
        demisto.results(
            {
                "Contents": json.loads(res.text),
                "ContentsFormat": formats["markdown"],
                "Type": entryTypes["note"],
                "HumanReadable": tableToMarkdown("QR Reader", json.loads(res.text)[0]["symbol"]),
                "EntryContext": {"GoQRCodeData": json.loads(res.text)[0]["symbol"]},
            }
        )


""" ENTRY POINT """

if __name__ in ("__main__", "__builtin__", "builtins"):
    main()