diff --git a/.codeclimate.yml b/.codeclimate.yml index 4e38504f8..fee31eafd 100644 --- a/.codeclimate.yml +++ b/.codeclimate.yml @@ -17,13 +17,32 @@ plugins: enabled: true fixme: enabled: true +checks: + argument-count: + config: + threshold: 7 + file-lines: + config: + threshold: 400 + method-complexity: + config: + threshold: 25 + method-lines: + config: + threshold: 70 + return-statements: + config: + threshold: 10 + method-count: + config: + threshold: 40 exclude_patterns: - config/ - db/ - dist/ - features/ - "**/node_modules/" - - script/ + - scripts/ - "**/spec/" - "**/test/" - "**/tests/" diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index fc5a4839c..7101adb16 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -1,7 +1,25 @@ +########################################################### +# General CI rules: +# * Create one CI.yml file per language/purpose +# * Include said CI.yml file below +# * We use rules in this CI, which means you cannot use only/except +# * The workflow rules define when the CI gets triggered, job rules are used to define when jobs get triggered +# * Do not commit any keys/ethereum addresses/private keys/etc directly, use environment variables or other methods +# * Thank you for reading this far! Get yourself a chocolate as a treat. +########################################################### + variables: COMMIT_IMAGE_TAG: $CI_REGISTRY_IMAGE:$CI_COMMIT_REF_NAME RELEASE_IMAGE_TAG: $CI_REGISTRY_IMAGE:latest +# Done to fix this bug: https://gitlab.com/gitlab-org/gitlab/issues/30111#note_275012413 +workflow: + rules: + - if: $CI_MERGE_REQUEST_IID + when: never + - when: always + +# defines all the stages in the CI, this includes all stages defined inside the included yml files stages: - build - bindings @@ -15,8 +33,9 @@ stages: - deploy - release +# all the CI files to include and run, they are imported before the CI is started include: - - template: Code-Quality.gitlab-ci.yml + - local: "code-quality.gitlab-ci.yml" - local: "/c/ci.yml" - local: "/c/ci-analyse.yml" - local: "/c/ci-deploy.yml" @@ -25,8 +44,3 @@ include: - local: "/python/ci.yml" - local: "/dotnet/ci.yml" - local: "/rust/ci.yml" -##### local_docker_deploy_and_vulnerability_analysis ##### - -##### analyse ##### - -##### deploy ##### diff --git a/.vscode/launch.json b/.vscode/launch.json index 7a6006585..9594115cb 100644 --- a/.vscode/launch.json +++ b/.vscode/launch.json @@ -87,6 +87,20 @@ "program": "${workspaceFolder}/build/test/test_ethapi", "cwd": "${workspaceFolder}/build" }, + { + "type": "lldb", + "request": "launch", + "name": "run tx example", + "program": "${workspaceFolder}/c/examples/send_transaction", + "cwd": "${workspaceFolder}/c/examples" + }, + { + "type": "lldb", + "request": "launch", + "name": "run sign test", + "program": "${workspaceFolder}/build/test/test_sign", + "cwd": "${workspaceFolder}/build" + }, { "type": "lldb", "request": "launch", diff --git a/CMakeLists.txt b/CMakeLists.txt index 56e0cf803..937a2b193 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -64,10 +64,12 @@ option(WASM_EMBED "embedds the wasm as base64-encoded into the js-file" ON) option(WASM_EMMALLOC "use ther smaller EMSCRIPTEN Malloc, which reduces the size about 10k, but may be a bit slower" ON) option(WASM_SYNC "intiaializes the WASM synchronisly, which allows to require and use it the same function, but this will not be supported by chrome (4k limit)" OFF) option(CODE_COVERAGE "Builds targets with code coverage instrumentation. (Requires GCC or Clang)" OFF) +option(GCC_ANALYZER "GCC10 static code analyses" OFF) option(PAY_ETH "support for direct Eth-Payment" OFF) option(USE_SCRYPT "integrate scrypt into the build in order to allow decrypt_key for scrypt encoded keys." ON) option(USE_CURL "if true the curl transport will be built (with a dependency to libcurl)" ON) option(DEV_NO_INTRN_PTR "(*dev option*) if true the client will NOT include a void pointer (named internal) for use by devs)" ON) +option(LEDGER_NANO "include support for nano ledger" OFF) if (USE_PRECOMPUTED_EC) ADD_DEFINITIONS(-DUSE_PRECOMPUTED_CP=1) @@ -119,6 +121,13 @@ if(IPFS) set(IN3_VERIFIER ${IN3_VERIFIER} ipfs) endif() +if(LEDGER_NANO AND ( NOT (WIN32 OR MSVC OR MSYS OR MINGW ))) + add_definitions(-DLEDGER_NANO) + set(HIDAPI true) +else() + set(HIDAPI false) +endif() + if(COLOR AND NOT (MSVC OR MSYS OR MINGW)) ADD_DEFINITIONS(-DLOG_USE_COLOR) endif() diff --git a/Dockerfile b/Dockerfile index b1d83cf6f..ee3a43357 100644 --- a/Dockerfile +++ b/Dockerfile @@ -40,7 +40,7 @@ RUN cd /in3/ && rm -rf build; RUN cd /in3/ && mkdir build && cd build && cmake -DCMAKE_BUILD_TYPE=MINSIZEREL -DIN3_SERVER=true -DUSE_CURL=false .. && make in3 -FROM alpine:latest +FROM alpine:edge COPY --from=build /in3/build/bin/in3 /bin/in3 EXPOSE 8545 ENTRYPOINT ["/bin/in3"] diff --git a/c/CMakeLists.txt b/c/CMakeLists.txt index b185e70d2..fe5df9c83 100644 --- a/c/CMakeLists.txt +++ b/c/CMakeLists.txt @@ -32,21 +32,33 @@ # with this program. If not, see . ############################################################################### - include("${PROJECT_SOURCE_DIR}/c/compiler.cmake") # build modules add_subdirectory(src/third-party) + + +if (GCC_ANALYZER) + add_compile_options(-fanalyzer -Werror) + set (CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fanalyzer -Werror") + set (CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fanalyzer -Werror") +endif() + add_subdirectory(src/core) add_subdirectory(src/transport) add_subdirectory(src/verifier) + +if( LEDGER_NANO AND HIDAPI ) + add_subdirectory(src/signer/ledger-nano/signer) +endif() + add_subdirectory(src/pay) add_subdirectory(src/api) IF (ETH_FULL) add_subdirectory(src/cmd) endif() add_subdirectory(docs) - +link_directories(${CMAKE_BINARY_DIR}/lib/) # create the library @@ -104,13 +116,21 @@ if (IN3_LIB) if (USE_SCRYPT) set(IN3_LIBS ${IN3_LIBS} $) endif() + + # create the libraries add_library(in3_bundle STATIC ${IN3_LIBS} ) add_library(in3_lib SHARED ${IN3_LIBS} ) set_target_properties(in3_bundle PROPERTIES OUTPUT_NAME "in3") set_target_properties(in3_lib PROPERTIES OUTPUT_NAME "in3") - target_link_libraries(in3_lib ${IN3_TRANSPORT}) + + if( LEDGER_NANO AND HIDAPI ) + target_link_libraries(in3_lib ${IN3_TRANSPORT} ledger_signer) + else() + target_link_libraries(in3_lib ${IN3_TRANSPORT} ) + endif() + # install INSTALL(TARGETS in3_bundle diff --git a/c/ci-analyse.yml b/c/ci-analyse.yml index c8d231afa..faebbf575 100644 --- a/c/ci-analyse.yml +++ b/c/ci-analyse.yml @@ -1,7 +1,16 @@ +.only_full: + rules: + - changes: + - c/**/* + - if: '$CI_COMMIT_TAG =~ /^v[0-9]+.[0-9]+.[0-9]+-(alpha|beta|rc)\.[0-9]+$/' + - if: '$CI_COMMIT_REF_NAME == "master"' + - if: '$CI_COMMIT_REF_NAME == "develop"' + coverage: stage: analysis image: silkeh/clang:dev coverage: '/TOTAL.*\s+(\d+.\d+\%)\s*$/' + extends: .only_full needs: [] tags: - short-jobs @@ -18,16 +27,17 @@ coverage: clangcheck: stage: analysis - image: docker.slock.it/build-images/cmake:clang10 + image: docker.slock.it/build-images/cmake:clang11 needs: [] + extends: .only_full allow_failure: false tags: - short-jobs script: - mkdir _build - cd _build - - scan-build-10 cmake -DTAG_VERSION=$CI_COMMIT_TAG -DCMAKE_BUILD_TYPE=DEBUG -DIN3_SERVER=true .. - - scan-build-10 --status-bugs --exclude ../c/src/third-party --force-analyze-debug-code -o ../report make + - scan-build-11 cmake -DTAG_VERSION=$CI_COMMIT_TAG -DCMAKE_BUILD_TYPE=DEBUG -DIN3_SERVER=true .. + - scan-build-11 --status-bugs --exclude ../c/src/third-party --force-analyze-debug-code -o ../report make artifacts: paths: - report @@ -35,6 +45,7 @@ clangcheck: cppcheck: stage: analysis image: docker.slock.it/build-images/cmake:gcc-x86-static-analysis + extends: .only_full allow_failure: true needs: [] tags: @@ -46,9 +57,24 @@ cppcheck: - cd .. - cppcheck --project=_build/compile_commands.json -i/builds/in3/c/in3-core/c/test/unity -i/builds/in3/c/in3-core/c/src/third-party +gcc10check: + stage: analysis + image: docker.slock.it/build-images/cmake:gcc10 + extends: .only_full + allow_failure: true + needs: [] + tags: + - short-jobs + script: + - mkdir _build + - cd _build + - cmake -DGCC_ANALYZER=true .. + - make + valgrind: stage: analysis image: docker.slock.it/build-images/cmake:valgrind + extends: .only_full # allow_failure: true needs: [] tags: @@ -64,10 +90,10 @@ valgrind: - for f in test/test*; do valgrind $VALGRIND_OPTS $(pwd)/$f; done code_quality: - only: - - /^v[0-9]+.[0-9]+.[0-9]+(\-RC[0-9]+)?$/ - except: - - branches + rules: + - if: '$CI_COMMIT_TAG =~ /^v[0-9]+.[0-9]+.[0-9]+(\-RC[0-9]+)?$/' + - if: '$CI_COMMIT_BRANCH == "master"' + - if: '$CI_COMMIT_BRANCH == "develop"' stage: analysis needs: [] tags: @@ -83,11 +109,11 @@ code_quality: format: stage: analysis needs: [] - image: docker.slock.it/build-images/cmake:clang10 + image: docker.slock.it/build-images/cmake:clang11 tags: - short-jobs script: - - find c/src/core/ c/src/cmd/ c/src/api/ c/src/verifier/ c/src/transport/ java \( -name "*.c" -o -name "*.h" -o -name "*.java" \) | xargs clang-format-10 -i + - find c/src/core/ c/src/cmd/ c/src/api/ c/src/verifier/ c/src/transport/ java \( -name "*.c" -o -name "*.h" -o -name "*.java" \) | xargs clang-format-11 -i - git diff --patch --exit-code cpd: @@ -102,7 +128,13 @@ cpd: - cpd --minimum-tokens 150 --language python --files python vulnerabilities: + rules: + - if: '$CI_COMMIT_TAG =~ /^v[0-9]+.[0-9]+.[0-9]+(\-RC[0-9]+)?$/' + - if: '$CI_COMMIT_BRANCH == "master"' + - if: '$CI_COMMIT_BRANCH == "develop"' stage: analysis + extends: .only_full + allow_failure: true needs: - docker tags: diff --git a/c/ci-deploy.yml b/c/ci-deploy.yml index 6973e6972..0af88784d 100644 --- a/c/ci-deploy.yml +++ b/c/ci-deploy.yml @@ -1,13 +1,23 @@ +# This template should be used for jobs to run during deployment only +.only_deploy: + rules: + - if: '$CI_COMMIT_TAG =~ /^v[0-9]+.[0-9]+.[0-9]+(\-RC[0-9]+)?$/' + when: manual + +.only_full: + rules: + - changes: + - c/**/* + - if: '$CI_COMMIT_TAG =~ /^v[0-9]+.[0-9]+.[0-9]+-(alpha|beta|rc)\.[0-9]+$/' + - if: '$CI_COMMIT_REF_NAME == "master"' + - if: '$CI_COMMIT_REF_NAME == "develop"' + dockerhub-deploy: stage: deploy needs: [] - only: - - /^v[0-9]+.[0-9]+.[0-9]+(\-RC[0-9]+)?$/ - except: - - branches + extends: .only_deploy tags: - short-jobs - when: manual services: - docker:dind image: docker.slock.it/build-images/deployment @@ -28,6 +38,7 @@ readthedocs: needs: - gcc8 - python + extends: .only_full tags: - short-jobs allow_failure: true @@ -58,11 +69,7 @@ release_mac_and_wasm: image: docker.slock.it/build-images/deployment tags: - short-jobs - only: - - /^v[0-9]+.[0-9]+.[0-9]+(\-RC[0-9]+)?$/ - except: - - branches - when: manual + extends: .only_deploy needs: - mac_os - gcc8 @@ -82,7 +89,7 @@ release_mac_and_wasm: - cp -r ../wasm_build/module wasm/release-wasm - cp -r ../asmjs_build/module wasm/release-asmjs - cp ../java_build/lib/in3.jar lib/in3.jar - - cp python_multilib/in3/libin3/shared/* python/in3/libin3/shared/ + - cp ../python_multilib/in3/libin3/shared/* python/in3/libin3/shared/ - cd .. - tar -zcv --exclude=*cmake* -f in3_${CI_COMMIT_TAG}_mac.tar.gz in3-mac-wasm/ - IPFS_RESPONSE=$(curl -X POST https://api.pinata.cloud/pinning/pinFileToIPFS -H 'Content-Type:multipart/form-data' -H 'pinata_api_key:'"$PINATA_API_KEY" -H 'pinata_secret_api_key:'"$PINATA_SECRET_API_KEY" -F file=@in3_${CI_COMMIT_TAG}_mac.tar.gz -F 'pinataMetadata={"name":"in3_'${CI_COMMIT_TAG}'_mac.tar.gz","keyValues":{"version":"${CI_COMMIT_TAG}"}}' -F 'pinataOptions={"cidVersion":0}') @@ -110,11 +117,7 @@ release_x64: - asmjs - java - python - only: - - /^v[0-9]+.[0-9]+.[0-9]+(\-RC[0-9]+)?$/ - except: - - branches - when: manual + extends: .only_deploy script: - export IMAGE_VERSION=$(echo ${CI_COMMIT_TAG} | grep -E '\d+.*' -o) - mkdir in3-x64 @@ -126,7 +129,7 @@ release_x64: - cp -r ../wasm_build/module wasm/release-wasm - cp -r ../asmjs_build/module wasm/release-asmjs - cp ../java_build/lib/in3.jar lib/in3.jar - - cp python_multilib/in3/libin3/shared/* python/in3/libin3/shared/ + - cp ../python_multilib/in3/libin3/shared/* python/in3/libin3/shared/ - cd .. - tar -zcv --exclude=*cmake* -f in3_${CI_COMMIT_TAG}_x64.tar.gz in3-x64/ - IPFS_RESPONSE=$(curl -X POST https://api.pinata.cloud/pinning/pinFileToIPFS -H 'Content-Type:multipart/form-data' -H 'pinata_api_key:'"$PINATA_API_KEY" -H 'pinata_secret_api_key:'"$PINATA_SECRET_API_KEY" -F file=@in3_${CI_COMMIT_TAG}_x64.tar.gz -F 'pinataMetadata={"name":"in3_'${CI_COMMIT_TAG}'_mac.tar.gz","keyValues":{"version":"${CI_COMMIT_TAG}"}}' -F 'pinataOptions={"cidVersion":0}') @@ -143,11 +146,7 @@ release_x86: image: docker.slock.it/build-images/deployment tags: - short-jobs - only: - - /^v[0-9]+.[0-9]+.[0-9]+(\-RC[0-9]+)?$/ - except: - - branches - when: manual + extends: .only_deploy needs: - gcc8 - gcc8-x86 @@ -167,7 +166,7 @@ release_x86: - cp -r ../wasm_build/module wasm/release-wasm - cp -r ../asmjs_build/module wasm/release-asmjs - cp ../java_build/lib/in3.jar lib/in3.jar - - cp python_multilib/in3/libin3/shared/* python/in3/libin3/shared/ + - cp ../python_multilib/in3/libin3/shared/* python/in3/libin3/shared/ - cd .. - tar -zcv --exclude=*cmake* -f in3_${CI_COMMIT_TAG}_x86.tar.gz in3-x86/ - IPFS_RESPONSE=$(curl -X POST https://api.pinata.cloud/pinning/pinFileToIPFS -H 'Content-Type:multipart/form-data' -H 'pinata_api_key:'"$PINATA_API_KEY" -H 'pinata_secret_api_key:'"$PINATA_SECRET_API_KEY" -F file=@in3_${CI_COMMIT_TAG}_x86.tar.gz -F 'pinataMetadata={"name":"in3_'${CI_COMMIT_TAG}'_x86.tar.gz","keyValues":{"version":"${CI_COMMIT_TAG}"}}' -F 'pinataOptions={"cidVersion":0}') @@ -184,11 +183,7 @@ release_arm7: image: docker.slock.it/build-images/deployment tags: - short-jobs - only: - - /^v[0-9]+.[0-9]+.[0-9]+(\-RC[0-9]+)?$/ - except: - - branches - when: manual + extends: .only_deploy needs: - gcc8 - arm7 @@ -208,7 +203,7 @@ release_arm7: - cp -r ../wasm_build/module wasm/release-wasm - cp -r ../asmjs_build/module wasm/release-asmjs - cp ../java_build/lib/in3.jar lib/in3.jar - - cp python_multilib/in3/libin3/shared/* python/in3/libin3/shared/ + - cp ../python_multilib/in3/libin3/shared/* python/in3/libin3/shared/ - cd .. - tar -zcv --exclude=*cmake* -f in3_${CI_COMMIT_TAG}_arm7.tar.gz in3-arm7/ - IPFS_RESPONSE=$(curl -X POST https://api.pinata.cloud/pinning/pinFileToIPFS -H 'Content-Type:multipart/form-data' -H 'pinata_api_key:'"$PINATA_API_KEY" -H 'pinata_secret_api_key:'"$PINATA_SECRET_API_KEY" -F file=@in3_${CI_COMMIT_TAG}_arm7.tar.gz -F 'pinataMetadata={"name":"in3_'${CI_COMMIT_TAG}'_arm7.tar.gz","keyValues":{"version":"${CI_COMMIT_TAG}"}}' -F 'pinataOptions={"cidVersion":0}') @@ -225,11 +220,7 @@ release_win: image: docker.slock.it/build-images/deployment tags: - short-jobs - only: - - /^v[0-9]+.[0-9]+.[0-9]+(\-RC[0-9]+)?$/ - except: - - branches - when: manual + extends: .only_deploy needs: - gcc8 - win_mingw @@ -253,7 +244,7 @@ release_win: - cp -r ../wasm_build/module wasm/release-wasm - cp -r ../asmjs_build/module wasm/release-asmjs - cp ../java_build/lib/in3.jar lib/in3.jar - - cp python_multilib/in3/libin3/shared/* python/in3/libin3/shared/ + - cp ../python_multilib/in3/libin3/shared/* python/in3/libin3/shared/ - cd .. - tar -zcv --exclude=*cmake* -f in3_${CI_COMMIT_TAG}_windows.tar.gz in3-win/ - IPFS_RESPONSE=$(curl -X POST https://api.pinata.cloud/pinning/pinFileToIPFS -H 'Content-Type:multipart/form-data' -H 'pinata_api_key:'"$PINATA_API_KEY" -H 'pinata_secret_api_key:'"$PINATA_SECRET_API_KEY" -F file=@in3_${CI_COMMIT_TAG}_windows.tar.gz -F 'pinataMetadata={"name":"in3_'${CI_COMMIT_TAG}'_windows.tar.gz","keyValues":{"version":"${CI_COMMIT_TAG}"}}' -F 'pinataOptions={"cidVersion":0}') @@ -265,30 +256,12 @@ release_win: paths: - in3-win -release_maven: - stage: deploy - image: docker.slock.it/build-images/maven-deployment-image:latest - tags: - - short-jobs - only: - - /^v[0-9]+.[0-9]+.[0-9]+(\-RC[0-9]+)?$/ - except: - - branches - when: manual - needs: - - java - script: - - touch settings.xml - - echo $MAVEN_SETTINGS > settings.xml - - mvn -s settings.xml deploy:deploy-file -DgroupId=it.slock -DartifactId=in3 -Dversion=$CI_COMMIT_TAG -Dpackaging=jar -Dfile=java_build/lib/in3.jar -DrepositoryId=github -Durl=https://maven.pkg.github.com/slockit/in3-c - pages: stage: deploy tags: - arm - only: - refs: - - develop + rules: + - if: '$CI_COMMIT_REF_NAME == "develop"' needs: - arm7 - readthedocs @@ -304,7 +277,7 @@ pages: - cp -r cov_build/ccov/all-merged public/coverage - cp -r report/* public/code_analysis - cp -r doc/build public/rtd - - cp -r vulnerability_analysis.json public/vulnerability_analysis.json + - cp -r vulnerability_analysis.json public/vulnerability_analysis.json || true - cp -r java/build/reports/jacoco/test/html public/coverage_java - echo "

Incubed report for last build

" > public/index.html artifacts: @@ -325,7 +298,6 @@ pages: - java_linux - java_macos - readthedocs - when: manual script: - mv scripts/debian . - mv debian/changelog-in3 debian/changelog @@ -352,24 +324,18 @@ pages: debian_package_deploy_bionic: extends: - .debian_package_deploy_template_in3 + - .only_deploy variables: DISTRO: "bionic" VERSION: $CI_COMMIT_TAG - only: - - /^v[0-9]+.[0-9]+.[0-9]+(\-RC[0-9]+)?$/ - except: - - branches debian_package_deploy_disco: extends: - .debian_package_deploy_template_in3 + - .only_deploy variables: DISTRO: "disco" VERSION: $CI_COMMIT_TAG - only: - - /^v[0-9]+.[0-9]+.[0-9]+(\-RC[0-9]+)?$/ - except: - - branches .debian_package_deploy_template_in3_dev: image: docker.slock.it/build-images/cmake:gcc8-with-debian-deps @@ -385,7 +351,6 @@ debian_package_deploy_disco: - java_linux - java_macos - readthedocs - when: manual script: - mv scripts/debian . - mv debian/changelog-dev debian/changelog @@ -412,35 +377,25 @@ debian_package_deploy_disco: debian_dev_package_deploy_bionic: extends: - .debian_package_deploy_template_in3_dev + - .only_deploy variables: DISTRO: "bionic" VERSION: $CI_COMMIT_TAG - only: - - /^v[0-9]+.[0-9]+.[0-9]+(\-RC[0-9]+)?$/ - except: - - branches debian__dev_package_deploy_disco: extends: - .debian_package_deploy_template_in3_dev + - .only_deploy variables: DISTRO: "disco" VERSION: $CI_COMMIT_TAG - only: - - /^v[0-9]+.[0-9]+.[0-9]+(\-RC[0-9]+)?$/ - except: - - branches brew_release: stage: release image: docker.slock.it/build-images/deployment tags: - short-jobs - only: - - /^v[0-9]+.[0-9]+.[0-9]+(\-RC[0-9]+)?$/ - except: - - branches - when: manual + extends: .only_deploy needs: - mac_os - release_mac_and_wasm @@ -463,11 +418,7 @@ github_body_release: image: docker.slock.it/build-images/deployment tags: - short-jobs - only: - - /^v[0-9]+.[0-9]+.[0-9]+(\-RC[0-9]+)?$/ - except: - - branches - when: manual + extends: .only_deploy needs: - release_mac_and_wasm - release_x64 diff --git a/c/ci.yml b/c/ci.yml index 82cfe9505..4b5ac53ba 100644 --- a/c/ci.yml +++ b/c/ci.yml @@ -1,3 +1,11 @@ +.only_full: + rules: + - changes: + - c/**/* + - if: '$CI_COMMIT_TAG =~ /^v[0-9]+.[0-9]+.[0-9]+-(alpha|beta|rc)\.[0-9]+$/' + - if: '$CI_COMMIT_REF_NAME == "master"' + - if: '$CI_COMMIT_REF_NAME == "develop"' + .conanbuild: stage: build needs: [] @@ -42,7 +50,9 @@ gcc8: win_mingw: image: docker.slock.it/build-images/cmake:gcc7-mingw - extends: .conanbuild + extends: + - .conanbuild + - .only_full variables: CONAN_OPTS: "-DLIBCURL_LINKTYPE=static -DJAVA=false" BUILD: "win_build" @@ -81,15 +91,21 @@ gcc8-x86: gcc5: image: docker.slock.it/build-images/cmake:gcc5 - extends: .conanbuild + extends: + - .conanbuild + - .only_full clang50: image: docker.slock.it/build-images/cmake:clang50 - extends: .conanbuild + extends: + - .conanbuild + - .only_full -clang10: - image: docker.slock.it/build-images/cmake:clang10 - extends: .conanbuild +clang11: + image: docker.slock.it/build-images/cmake:clang11 + extends: + - .conanbuild + - .only_full mac_os: needs: [] @@ -118,6 +134,7 @@ mac_os: docker: stage: bindings needs: [] + extends: .only_full tags: - short-jobs services: @@ -157,6 +174,7 @@ test_qemu: image: docker.io/zephyrprojectrtos/zephyr-build:v0.12 stage: test needs: [] + extends: .only_full script: - west init -m https://github.com/zephyrproject-rtos/zephyr --mr v2.0.0 - export ZEPHYR_BASE=/builds/in3/c/in3-core diff --git a/c/docs/1_install.md b/c/docs/1_install.md index 1d76e7176..f091f8176 100644 --- a/c/docs/1_install.md +++ b/c/docs/1_install.md @@ -32,7 +32,7 @@ Default-Value: `-DASMJS=OFF` if true, the bitcoin verifiers will be build -Default-Value: `-DBTC=OFF` +Default-Value: `-DBTC=ON` #### BUILD_DOC @@ -63,6 +63,13 @@ Default-Value: `-DCODE_COVERAGE=OFF` Default-Value: `-DCOLOR=ON` +#### DEV_NO_INTRN_PTR + + (*dev option*) if true the client will NOT include a void pointer (named internal) for use by devs) + +Default-Value: `-DDEV_NO_INTRN_PTR=ON` + + #### ERR_MSG if set human readable error messages will be inculded in th executable, otherwise only the error code is used. (saves about 19kB) @@ -147,6 +154,13 @@ Default-Value: `-DIPFS=ON` Default-Value: `-DJAVA=OFF` +#### PAY_ETH + + support for direct Eth-Payment + +Default-Value: `-DPAY_ETH=OFF` + + #### PKG_CONFIG_EXECUTABLE pkg-config executable diff --git a/c/examples/build.sh b/c/examples/build.sh index 4ceed5e05..49df759e9 100755 --- a/c/examples/build.sh +++ b/c/examples/build.sh @@ -13,11 +13,14 @@ if [ ! -d /usr/local/include/in3 ]; then fi # set the library path to use the local - BUILDARGS="-L../../build/lib/ -I../../c/include" + BUILDARGS="-L../../build/lib/ -I../../c/include/ " fi - # now build the examples build for f in *.c; - do gcc -std=c99 -o "${f%%.*}" $f $BUILDARGS -lin3 -D_POSIX_C_SOURCE=199309L + do + if [ "$f" == ledger_sign.c ]; then # skipping ledger_sign compilation as it requires specific dependencies + continue + fi + gcc -std=c99 -o "${f%%.*}" $f $BUILDARGS -lin3 -D_POSIX_C_SOURCE=199309L done diff --git a/c/examples/ledger_sign.c b/c/examples/ledger_sign.c new file mode 100644 index 000000000..850538fd2 --- /dev/null +++ b/c/examples/ledger_sign.c @@ -0,0 +1,48 @@ + +#include // the core client +#include // functions for direct api-access +#include // if included the verifier will automaticly be initialized. +#include //to invoke ledger nano device for signing +#include // logging functions +#include +#include + +static void send_tx_api(in3_t* in3); + +int main() { + // create new incubed client + uint8_t bip_path[5] = {44, 60, 0, 0, 0}; + in3_t* in3 = in3_for_chain(ETH_CHAIN_ID_MAINNET); + in3_log_set_level(LOG_DEBUG); + // setting ledger nano s to be the default signer for incubed client + // it will cause the transaction or any msg to be sent to ledger nanos device for siging + eth_ledger_set_signer(in3, bip_path); + + // send tx using API + send_tx_api(in3); + + // cleanup client after usage + in3_free(in3); +} + +void send_tx_api(in3_t* in3) { + // prepare parameters + address_t to, from; + hex_to_bytes("0xC51fBbe0a68a7cA8d33f14a660126Da2A2FAF8bf", -1, from, 20); + hex_to_bytes("0xd46e8dd67c5d32be8058bb8eb970870f07244567", -1, to, 20); + + bytes_t* data = hex_to_new_bytes("d46e8dd67c5d32be8d46e8dd67c5d32be8058bb8eb970870f072445675058bb8eb970870f072445675", 82); + + // send the tx + bytes_t* tx_hash = eth_sendTransaction(in3, from, to, OPTIONAL_T_VALUE(uint64_t, 0x96c0), OPTIONAL_T_VALUE(uint64_t, 0x9184e72a000), OPTIONAL_T_VALUE(uint256_t, to_uint256(0x9184e72a)), OPTIONAL_T_VALUE(bytes_t, *data), OPTIONAL_T_UNDEFINED(uint64_t)); + + // if the result is null there was an error and we can get the latest error message from eth_last_error() + if (!tx_hash) + printf("error sending the tx : %s\n", eth_last_error()); + else { + printf("Transaction hash: "); + b_print(tx_hash); + b_free(tx_hash); + } + b_free(data); +} diff --git a/c/include/in3.rs.h b/c/include/in3.rs.h index fc87c0243..8eb23d120 100644 --- a/c/include/in3.rs.h +++ b/c/include/in3.rs.h @@ -1,10 +1,15 @@ // AUTO-GENERATED FILE // See scripts/build_includeh.sh #include "../src/core/client/context_internal.h" +#include "../src/third-party/crypto/ecdsa.h" +#include "../src/third-party/crypto/hasher.h" +#include "../src/third-party/crypto/secp256k1.c" +#include "../src/verifier/eth1/basic/signer-priv.h" +#include "../src/verifier/eth1/basic/signer.h" #include "in3/bytes.h" #include "in3/client.h" #include "in3/context.h" #include "in3/error.h" #include "in3/eth_api.h" -#include "in3/in3_init.h" #include "in3/in3_curl.h" +#include "in3/in3_init.h" diff --git a/c/include/in3/error.h b/c/include/in3/error.h index e973f4d81..a1d9399c2 100644 --- a/c/include/in3/error.h +++ b/c/include/in3/error.h @@ -69,6 +69,7 @@ typedef enum { IN3_WAITING = -16, /**< the process can not be finished since we are waiting for responses */ IN3_EIGNORE = -17, /**< Ignorable error */ IN3_EPAYMENT_REQUIRED = -18, /**< payment required */ + IN3_ENODEVICE = -19, /**< harware wallet device not connected */ } in3_ret_t; /** Optional type similar to C++ std::optional diff --git a/c/include/in3/ledger_signer.h b/c/include/in3/ledger_signer.h new file mode 100644 index 000000000..548385094 --- /dev/null +++ b/c/include/in3/ledger_signer.h @@ -0,0 +1,49 @@ +/******************************************************************************* + * This file is part of the Incubed project. + * Sources: https://github.com/slockit/in3-c + * + * Copyright (C) 2018-2020 slock.it GmbH, Blockchains LLC + * + * + * COMMERCIAL LICENSE USAGE + * + * Licensees holding a valid commercial license may use this file in accordance + * with the commercial license agreement provided with the Software or, alternatively, + * in accordance with the terms contained in a written agreement between you and + * slock.it GmbH/Blockchains LLC. For licensing terms and conditions or further + * information please contact slock.it at in3@slock.it. + * + * Alternatively, this file may be used under the AGPL license as follows: + * + * AGPL LICENSE USAGE + * + * This program is free software: you can redistribute it and/or modify it under the + * terms of the GNU Affero General Public License as published by the Free Software + * Foundation, either version 3 of the License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, but WITHOUT ANY + * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A + * PARTICULAR PURPOSE. See the GNU Affero General Public License for more details. + * [Permissions of this strong copyleft license are conditioned on making available + * complete source code of licensed works and modifications, which include larger + * works using a licensed work, under the same license. Copyright and license notices + * must be preserved. Contributors provide an express grant of patent rights.] + * You should have received a copy of the GNU Affero General Public License along + * with this program. If not, see . + *******************************************************************************/ + +// @PUBLIC_HEADER +/** @file + * this file defines the incubed configuration struct and it registration. + * + * + * */ + +#ifndef in3_ledger_signer_h__ +#define in3_ledger_signer_h__ + +#include "client.h" + +in3_ret_t eth_ledger_set_signer(in3_t* in3, uint8_t* bip_path); + +#endif diff --git a/c/include/in3/signer.h b/c/include/in3/signer.h index 1a3a4c68d..65c6ad061 100644 --- a/c/include/in3/signer.h +++ b/c/include/in3/signer.h @@ -49,4 +49,9 @@ */ in3_ret_t eth_set_pk_signer(in3_t* in3, bytes32_t pk); +/** + * simply signer with one private key as hex. + */ +uint8_t* eth_set_pk_signer_hex(in3_t* in3, char* key); + #endif diff --git a/c/src/api/CMakeLists.txt b/c/src/api/CMakeLists.txt index 361a0c819..337625915 100644 --- a/c/src/api/CMakeLists.txt +++ b/c/src/api/CMakeLists.txt @@ -39,6 +39,7 @@ IF (IN3API) add_subdirectory(eth1) add_subdirectory(usn) + IF (IPFS) add_subdirectory(ipfs) diff --git a/c/src/api/eth1/ens.c b/c/src/api/eth1/ens.c index 1fc7b019d..44dc6caa9 100644 --- a/c/src/api/eth1/ens.c +++ b/c/src/api/eth1/ens.c @@ -130,6 +130,7 @@ in3_ret_t ens_resolve(in3_ctx_t* parent, char* name, const address_t registry, i } else switch (parent->client->chain_id) { case ETH_CHAIN_ID_MAINNET: + case ETH_CHAIN_ID_GOERLI: registry_address = "0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e"; break; default: diff --git a/c/src/api/eth1/eth_api.c b/c/src/api/eth1/eth_api.c index 26a27c1c5..cf3b99354 100644 --- a/c/src/api/eth1/eth_api.c +++ b/c/src/api/eth1/eth_api.c @@ -543,8 +543,11 @@ uint64_t eth_estimate_fn(in3_t* in3, address_t contract, eth_blknum_t block, cha va_start(ap, fn_sig); uint64_t* response = eth_call_fn_intern(in3, contract, block, true, fn_sig, ap); va_end(ap); - uint64_t tmp = *response; - _free(response); + uint64_t tmp = response ? *response : 0; + if (response) + _free(response); + else + api_set_error(ENOMEM, "No response!"); return tmp; } diff --git a/c/src/cmd/in3/CMakeLists.txt b/c/src/cmd/in3/CMakeLists.txt index 43d7b00e2..2efbea5b8 100644 --- a/c/src/cmd/in3/CMakeLists.txt +++ b/c/src/cmd/in3/CMakeLists.txt @@ -60,7 +60,12 @@ endif() add_executable(in3 main.c in3_storage.c) target_compile_definitions(in3 PRIVATE _XOPEN_SOURCE=600) -target_link_libraries(in3 ${LIBS} eth_full ${IN3_API} -lm) + +if( LEDGER_NANO AND HIDAPI) + target_link_libraries(in3 ${LIBS} eth_full ${IN3_API} ledger_signer -lm) +else() + target_link_libraries(in3 ${LIBS} eth_full ${IN3_API} -lm) +endif() install(TARGETS in3 DESTINATION /usr/local/bin/ diff --git a/c/src/cmd/in3/main.c b/c/src/cmd/in3/main.c index 518f014ee..8e4375c21 100644 --- a/c/src/cmd/in3/main.c +++ b/c/src/cmd/in3/main.c @@ -35,7 +35,6 @@ /** @file * simple commandline-util sending in3-requests. * */ - #include "../../api/eth1/abi.h" #include "../../api/eth1/eth_api.h" #include "../../core/util/bitset.h" @@ -60,6 +59,11 @@ #include "../../core/client/nodelist.h" #include "../../core/client/version.h" #include "../../core/util/colors.h" + +#if defined(LEDGER_NANO) +#include "../../signer/ledger-nano/signer/ledger_signer.h" +#endif + #include "../../verifier/eth1/basic/signer.h" #include "../../verifier/eth1/evm/evm.h" #include "../../verifier/eth1/full/eth_full.h" @@ -108,6 +112,7 @@ void show_help(char* name) { -d, -data the data for a transaction. This can be a filepath, a 0x-hexvalue or - for stdin.\n\ -gas the gas limit to use when sending transactions. (default: 100000) \n\ -pk the private key as raw as keystorefile \n\ +-bip32 the bip32 path which is to be used for signing in hardware wallet \n\ -st, -sigtype the type of the signature data : eth_sign (use the prefix and hash it), raw (hash the raw data), hash (use the already hashed data). Default: raw \n\ -pwd password to unlock the key \n\ -value the value to send when sending a transaction. can be hexvalue or a float/integer with the suffix eth or wei like 1.8eth (default: 0)\n\ @@ -615,6 +620,9 @@ int main(int argc, char* argv[]) { params[1] = 0; int p = 1, i; bytes32_t pk; +#ifdef LEDGER_NANO + uint8_t bip32[5]; +#endif // we want to verify all in3_register_eth_full(); @@ -683,9 +691,19 @@ int main(int argc, char* argv[]) { if (strcmp(argv[i], "-pk") == 0) { // private key? if (argv[i + 1][0] == '0' && argv[i + 1][1] == 'x') { hex_to_bytes(argv[++i], -1, pk, 32); + eth_set_pk_signer(c, pk); } else pk_file = argv[++i]; + } else if (strcmp(argv[i], "-bip32") == 0) { +#if defined(LEDGER_NANO) + if (argv[i + 1][0] == '0' && argv[i + 1][1] == 'x') { + hex_to_bytes(argv[++i], -1, bip32, 5); + eth_ledger_set_signer(c, bip32); + } +#else + die("bip32 option not supported currently "); +#endif } else if (strcmp(argv[i], "-chain") == 0 || strcmp(argv[i], "-c") == 0) // chain_id set_chain_id(c, argv[++i]); else if (strcmp(argv[i], "-ccache") == 0) // NOOP - should have been handled earlier @@ -958,7 +976,7 @@ int main(int argc, char* argv[]) { sig_type = "raw"; } - if (!c->signer) die("No private key given"); + if (!c->signer) die("No private key/bip32 path given"); uint8_t sig[65]; in3_ctx_t ctx; ctx.client = c; diff --git a/c/src/core/client/client.c b/c/src/core/client/client.c index 4499c50a4..df62815c6 100644 --- a/c/src/core/client/client.c +++ b/c/src/core/client/client.c @@ -213,6 +213,31 @@ in3_signer_t* in3_create_signer( return signer; } +/** + * set the transport handler on the client. + */ +void in3_set_transport( + in3_t* c, /**< the incubed client */ + void* cptr /**< custom pointer which will will be passed to functions */ +) { + c->transport = cptr; +} + +/** + * set the signer on the client. + * the caller will need to free this pointer after usage. + */ +in3_signer_t* in3_set_signer( + in3_t* c, /**< the incubed client */ + in3_sign sign, /**< function pointer returning a stored value for the given key.*/ + in3_prepare_tx prepare_tx, /**< function pointer returning capable of manipulating the transaction before signing it. This is needed in order to support multisigs.*/ + void* wallet /**signer = signer; + return signer; +} + in3_storage_handler_t* in3_set_storage_handler( in3_t* c, /**< the incubed client */ in3_storage_get_item get_item, /**< function pointer returning a stored value for the given key.*/ diff --git a/c/src/core/client/client_init.c b/c/src/core/client/client_init.c index 044e7cdc3..142d45c97 100644 --- a/c/src/core/client/client_init.c +++ b/c/src/core/client/client_init.c @@ -88,7 +88,7 @@ void in3_register_payment( #define EXPECT_CFG(cond, err) EXPECT(cond, { \ res = malloc(strlen(err) + 1); \ - strcpy(res, err); \ + if (res) strcpy(res, err); \ goto cleanup; \ }) #define EXPECT_CFG_NCP_ERR(cond, err) EXPECT(cond, { res = err; goto cleanup; }) @@ -587,7 +587,7 @@ char* in3_get_config(in3_t* c) { if (c->replace_latest_block) add_uint(sb, ',', "replaceLatestBlock", c->replace_latest_block); add_uint(sb, ',', "requestCount", c->request_count); - if (c->chain_id == ETH_CHAIN_ID_LOCAL) + if (c->chain_id == ETH_CHAIN_ID_LOCAL && chain) add_string(sb, ',', "rpc", chain->nodelist->url); sb_add_chars(sb, ",\"nodes\":{"); @@ -683,6 +683,7 @@ char* in3_configure(in3_t* c, const char* config) { } else if (token->key == key("maxVerifiedHashes")) { EXPECT_TOK_U16(token); in3_chain_t* chain = in3_find_chain(c, c->chain_id); + EXPECT_CFG(chain, "chain not found"); if (c->max_verified_hashes < d_long(token)) { chain->verified_hashes = _realloc(chain->verified_hashes, sizeof(in3_verified_hash_t) * d_long(token), diff --git a/c/src/core/client/execute.c b/c/src/core/client/execute.c index 739c4f730..a97226085 100644 --- a/c/src/core/client/execute.c +++ b/c/src/core/client/execute.c @@ -576,7 +576,7 @@ static bool ctx_is_allowed_to_fail(in3_ctx_t* ctx) { } in3_ret_t ctx_handle_failable(in3_ctx_t* ctx) { - ctx_remove_required(ctx, ctx->required); + in3_ret_t res = IN3_OK; // blacklist node that gave us an error response for nodelist (if not first update) // and clear nodelist params @@ -587,11 +587,16 @@ in3_ret_t ctx_handle_failable(in3_ctx_t* ctx) { _free(chain->nodelist_upd8_params); chain->nodelist_upd8_params = NULL; - // if first update return error otherwise return IN3_OK, this is because first update is - // always from a boot node which is presumed to be trusted - if (nodelist_first_upd8(chain)) - return ctx_set_error(ctx, ctx->required->error ? ctx->required->error : "error handling subrequest", IN3_ERPC); - return IN3_OK; + if (ctx->required) { + // if first update return error otherwise return IN3_OK, this is because first update is + // always from a boot node which is presumed to be trusted + if (nodelist_first_upd8(chain)) + res = ctx_set_error(ctx, ctx->required->error ? ctx->required->error : "error handling subrequest", IN3_ERPC); + + if (res == IN3_OK) res = ctx_remove_required(ctx, ctx->required); + } + + return res; } in3_ret_t in3_send_ctx(in3_ctx_t* ctx) { @@ -657,7 +662,7 @@ in3_ret_t in3_send_ctx(in3_ctx_t* ctx) { sb_add_range(&ctx->raw_response->result, (char*) sig, 0, 65); break; } else - return ctx_set_error(ctx, "no transport set", IN3_ECONFIG); + return ctx_set_error(ctx, "no signer set", IN3_ECONFIG); } } } diff --git a/c/src/core/util/data.c b/c/src/core/util/data.c index f3c7574d1..696c402d6 100644 --- a/c/src/core/util/data.c +++ b/c/src/core/util/data.c @@ -964,3 +964,7 @@ d_token_t* d_getl(d_token_t* item, uint16_t k, uint32_t minl) { d_get_byteskl(item, k, minl); return d_get(item, k); } + +d_iterator_t d_iter(d_token_t* parent) { + return (d_iterator_t){.left = d_len(parent), .token = parent + 1}; +} /**< creates a iterator for a object or array */ diff --git a/c/src/core/util/data.h b/c/src/core/util/data.h index 6039c43c4..d8b302d6d 100644 --- a/c/src/core/util/data.h +++ b/c/src/core/util/data.h @@ -104,19 +104,22 @@ typedef struct json_parser { * Objects or arrays will return 0x. */ bytes_t d_to_bytes(d_token_t* item); -int d_bytes_to(d_token_t* item, uint8_t* dst, const int max); /**< writes the byte-representation to the dst. details see d_to_bytes.*/ -bytes_t* d_bytes(const d_token_t* item); /**< returns the value as bytes (Carefully, make sure that the token is a bytes-type!)*/ -bytes_t* d_bytesl(d_token_t* item, size_t l); /**< returns the value as bytes with length l (may reallocates) */ -char* d_string(const d_token_t* item); /**< converts the value as string. Make sure the type is string! */ -int32_t d_int(const d_token_t* item); /**< returns the value as integer. only if type is integer */ -int32_t d_intd(const d_token_t* item, const uint32_t def_val); /**< returns the value as integer or if NULL the default. only if type is integer */ -uint64_t d_long(const d_token_t* item); /**< returns the value as long. only if type is integer or bytes, but short enough */ -uint64_t d_longd(const d_token_t* item, const uint64_t def_val); /**< returns the value as long or if NULL the default. only if type is integer or bytes, but short enough */ -bytes_t** d_create_bytes_vec(const d_token_t* arr); /** creates a array of bytes from JOSN-array */ -static inline d_type_t d_type(const d_token_t* item) { return item == NULL ? T_NULL : (item->len & 0xF0000000) >> 28; } /**< type of the token */ -static inline int d_len(const d_token_t* item) { return item == NULL ? 0 : item->len & 0xFFFFFFF; } /**< number of elements in the token (only for object or array, other will return 0) */ -bool d_eq(const d_token_t* a, const d_token_t* b); /**< compares 2 token and if the value is equal */ -d_key_t keyn(const char* c, const size_t len); /**< generates the keyhash for the given stringrange as defined by len */ +int d_bytes_to(d_token_t* item, uint8_t* dst, const int max); /**< writes the byte-representation to the dst. details see d_to_bytes.*/ +bytes_t* d_bytes(const d_token_t* item); /**< returns the value as bytes (Carefully, make sure that the token is a bytes-type!)*/ +bytes_t* d_bytesl(d_token_t* item, size_t l); /**< returns the value as bytes with length l (may reallocates) */ +char* d_string(const d_token_t* item); /**< converts the value as string. Make sure the type is string! */ +int32_t d_int(const d_token_t* item); /**< returns the value as integer. only if type is integer */ +int32_t d_intd(const d_token_t* item, const uint32_t def_val); /**< returns the value as integer or if NULL the default. only if type is integer */ +uint64_t d_long(const d_token_t* item); /**< returns the value as long. only if type is integer or bytes, but short enough */ +uint64_t d_longd(const d_token_t* item, const uint64_t def_val); /**< returns the value as long or if NULL the default. only if type is integer or bytes, but short enough */ +bytes_t** d_create_bytes_vec(const d_token_t* arr); /** creates a array of bytes from JOSN-array */ +static inline d_type_t d_type(const d_token_t* item) { return (item ? ((item->len & 0xF0000000) >> 28) : T_NULL); } /**< type of the token */ +static inline int d_len(const d_token_t* item) { /**< number of elements in the token (only for object or array, other will return 0) */ + if (item == NULL) return 0; + return item->len & 0xFFFFFFF; +} +bool d_eq(const d_token_t* a, const d_token_t* b); /**< compares 2 token and if the value is equal */ +d_key_t keyn(const char* c, const size_t len); /**< generates the keyhash for the given stringrange as defined by len */ d_token_t* d_get(d_token_t* item, const uint16_t key); /**< returns the token with the given propertyname (only if item is a object) */ d_token_t* d_get_or(d_token_t* item, const uint16_t key1, const uint16_t key2); /**< returns the token with the given propertyname or if not found, tries the other. (only if item is a object) */ @@ -191,8 +194,8 @@ typedef struct d_iterator { int left; /**< number of result left */ } d_iterator_t; -static inline d_iterator_t d_iter(d_token_t* parent) { return (d_iterator_t){.left = d_len(parent), .token = parent + 1}; } /**< creates a iterator for a object or array */ -static inline bool d_iter_next(d_iterator_t* const iter) { +d_iterator_t d_iter(d_token_t* parent); /**< creates a iterator for a object or array */ +static inline bool d_iter_next(d_iterator_t* const iter) { iter->token = d_next(iter->token); return iter->left--; } /**< fetched the next token an returns a boolean indicating whther there is a next or not.*/ diff --git a/c/src/core/util/debug.c b/c/src/core/util/debug.c index 991293341..de001adaa 100644 --- a/c/src/core/util/debug.c +++ b/c/src/core/util/debug.c @@ -98,6 +98,7 @@ char* in3_errmsg(in3_ret_t err /**< the error code */) { case IN3_WAITING: return "waiting for data"; case IN3_EIGNORE: return "ignoreable error"; case IN3_EPAYMENT_REQUIRED: return "payment required"; + case IN3_ENODEVICE: return "no hardware wallet connected"; } return NULL; #else diff --git a/c/src/core/util/error.h b/c/src/core/util/error.h index e973f4d81..a1d9399c2 100644 --- a/c/src/core/util/error.h +++ b/c/src/core/util/error.h @@ -69,6 +69,7 @@ typedef enum { IN3_WAITING = -16, /**< the process can not be finished since we are waiting for responses */ IN3_EIGNORE = -17, /**< Ignorable error */ IN3_EPAYMENT_REQUIRED = -18, /**< payment required */ + IN3_ENODEVICE = -19, /**< harware wallet device not connected */ } in3_ret_t; /** Optional type similar to C++ std::optional diff --git a/c/src/signer/ledger-nano/README.md b/c/src/signer/ledger-nano/README.md new file mode 100644 index 000000000..314588937 --- /dev/null +++ b/c/src/signer/ledger-nano/README.md @@ -0,0 +1,85 @@ +# Integration of ledger nano s with incubed + 1. Setup development environment for ledger nano s + 2. Build and install ledger nano Signer app into Ledger nano s usb device + 3. Install libusb hidlib + 4. Start using ledger nano s device with Incubed + +# Setup development environment for ledger nano s + Setting up dev environment for Ledger nano s is one time activity and Signer application will be available to install directly from Ledger Manager in future. Ledger applications need linux System (recommended is Ubuntu) to build the binary to be installed on Ledger nano devices + +## Download Toolchains and Nanos ledger SDK (As per latest Ubuntu LTS) + +Download the Nano S SDK in bolos-sdk folder +$ git clone https://github.com/ledgerhq/nanos-secure-sdk + +Download a prebuild gcc and move it to bolos-sdk folder + https://launchpad.net/gcc-arm-embedded/+milestone/5-2016-q1-update + +Download a prebuild clang and rename the folder to clang-arm-fropi then move it to bolos-sdk folder + http://releases.llvm.org/download.html#4.0.0 + + +## Add environment variables: + +sudo -H gedit /etc/environment + +ADD PATH TO BOLOS SDK: +BOLOS_SDK="/nanos-secure-sdk" + +ADD GCCPATH VARIABLE +GCCPATH="/gcc-arm-none-eabi-5_3-2016q1/bin/" + +ADD CLANGPATH +CLANGPATH="/clang-arm-fropi/bin/" + + +## Download and install ledger python tools + +Installation prerequisites :
+$ sudo apt-get install libudev-dev
+$ sudo apt-get install libusb-1.0-0-dev
+$ sudo apt-get install python-dev (python 2.7)
+$ sudo apt-get install virtualenv
+ +Installation of ledgerblue:
+$ virtualenv ledger
+$ source ledger/bin/activate
+$ pip install ledgerblue
+ +Ref: https://github.com/LedgerHQ/blue-loader-python + + + +## Download and install ledger udev rules + +$ git clone https://github.com/LedgerHQ/udev-rules + +run script from the above download
+$ sudo ./add_udev_rules.sh + + + +## Open new terminal and check for following installations :- +
+$ sudo apt-get install gcc-multilib +$ sudo apt-get install libc6-dev:i386 + +=================================================================== + +# Build and install ledger nano Signer app into Ledger nano s usb device +Once the setup is done, go to ledger-incubed-firmware-app folder and run:- + +$ make
+$ make load + +=================================================================== + +# Install libusb hidlib +HIDAPI library is required to interact with ledger nano s device over usb , it is available for multiple platforms and can be cross compiled easily + +Ref: https://github.com/libusb/hidapi +=================================================================== + +# Start using ledger nano s device with Incubed + +Open the application on your ledger nano s usb device and make signing requests from incubed \ No newline at end of file diff --git a/c/src/signer/ledger-nano/firmware/Makefile b/c/src/signer/ledger-nano/firmware/Makefile new file mode 100755 index 000000000..d63f8eaaa --- /dev/null +++ b/c/src/signer/ledger-nano/firmware/Makefile @@ -0,0 +1,86 @@ +#******************************************************************************* +# Ledger Blue +# (c) 2016 Ledger +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +#******************************************************************************* + + + +ifeq ($(BOLOS_SDK),) +$(error BOLOS_SDK is not set) +endif +include $(BOLOS_SDK)/Makefile.defines + +# Main app configuration + +APPNAME = "Incubed Signer" +APPVERSION = 1.0.0 +APP_LOAD_PARAMS = --appFlags 0x00 $(COMMON_LOAD_PARAMS) + +# Build configuration + +APP_SOURCE_PATH += src +SDK_SOURCE_PATH += lib_stusb lib_stusb_impl + +DEFINES += APPVERSION=\"$(APPVERSION)\" + +DEFINES += OS_IO_SEPROXYHAL IO_SEPROXYHAL_BUFFER_SIZE_B=128 +DEFINES += HAVE_BAGL HAVE_SPRINTF +#DEFINES += PRINTF\(...\)= +DEFINES += HAVE_SPRINTF HAVE_PRINTF PRINTF=screen_printf +DEFINES += HAVE_IO_USB HAVE_L4_USBLIB IO_USB_MAX_ENDPOINTS=7 IO_HID_EP_LENGTH=64 HAVE_USB_APDU + +DEFINES += CX_COMPLIANCE_141 + +# Compiler, assembler, and linker + +ifneq ($(BOLOS_ENV),) +$(info BOLOS_ENV=$(BOLOS_ENV)) +CLANGPATH := $(BOLOS_ENV)/clang-arm-fropi/bin/ +GCCPATH := $(BOLOS_ENV)/gcc-arm-none-eabi-5_3-2016q1/bin/ +else +$(info BOLOS_ENV is not set: falling back to CLANGPATH and GCCPATH) +endif + +ifeq ($(CLANGPATH),) +$(info CLANGPATH is not set: clang will be used from PATH) +endif + +ifeq ($(GCCPATH),) +$(info GCCPATH is not set: arm-none-eabi-* will be used from PATH) +endif + +CC := $(CLANGPATH)clang +CFLAGS += -O3 -Os + +AS := $(GCCPATH)arm-none-eabi-gcc +AFLAGS += + +LD := $(GCCPATH)arm-none-eabi-gcc +LDFLAGS += -O3 -Os +LDLIBS += -lm -lgcc -lc + +# Main rules + +all: default + +load: all + python3 -m ledgerblue.loadApp $(APP_LOAD_PARAMS) + +delete: + python3 -m ledgerblue.deleteApp $(COMMON_DELETE_PARAMS) + +# Import generic rules from the SDK + +include $(BOLOS_SDK)/Makefile.rules diff --git a/c/src/signer/ledger-nano/firmware/README.md b/c/src/signer/ledger-nano/firmware/README.md new file mode 100644 index 000000000..88fec7aaf --- /dev/null +++ b/c/src/signer/ledger-nano/firmware/README.md @@ -0,0 +1,5 @@ +# Sample Signature App for Ledger Blue & Ledger Nano S + + + +Run `make load` to build and load the application onto the device. \ No newline at end of file diff --git a/c/src/signer/ledger-nano/firmware/src/apdu.c b/c/src/signer/ledger-nano/firmware/src/apdu.c new file mode 100755 index 000000000..8d94e956c --- /dev/null +++ b/c/src/signer/ledger-nano/firmware/src/apdu.c @@ -0,0 +1,144 @@ +#include "apdu.h" + +#include "menu.h" +#include "operations.h" +#include "ui.h" +#include +#include +#include + +ux_state_t ux; + +void main_loop(void) { + volatile unsigned int rx = 0; + volatile unsigned int tx = 0; + volatile unsigned int flags = 0; + int isequal; + char* ans; + + // next timer callback in 500 ms + UX_CALLBACK_SET_INTERVAL(500); + + // DESIGN NOTE: the bootloader ignores the way APDU are fetched. The only + // goal is to retrieve APDU. + // When APDU are to be fetched from multiple IOs, like NFC+USB+BLE, make + // sure the io_event is called with a + // switch event, before the apdu is replied to the bootloader. This avoid + // APDU injection faults. + for (;;) { + volatile unsigned short sw = 0; + + BEGIN_TRY { + TRY { + rx = tx; + tx = 0; // ensure no race in catch_other if io_exchange throws an error + + rx = io_exchange(CHANNEL_APDU | flags, rx); + flags = 0; + + // no apdu received, well, reset the session, and reset the + // bootloader configuration + if (rx == 0) { + THROW(EXC_SECURITY); + } + + if (G_io_apdu_buffer[0] != CLA) { + THROW(EXC_CLASS); + } + + switch (G_io_apdu_buffer[1]) { + + case INS_SIGN: { + + if ((G_io_apdu_buffer[2] != P1_MORE) && + (G_io_apdu_buffer[2] != P1_LAST)) { + THROW(EXC_WRONG_PARAM_P1P2); + } + + current_text_pos = 0; + text_y = 60; + cx_ecfp_public_key_t publicKey; + cx_ecfp_private_key_t privateKey; + cx_curve_t curve_id = curve_code_to_curve(G_io_apdu_buffer[3]); + + if (G_io_apdu_buffer[4] != TAG_ARG1) { + THROW(EXC_WRONG_PARAM); + } + + int path_length = G_io_apdu_buffer[5]; + unsigned char bip32_path[path_length]; + memcpy(bip32_path, G_io_apdu_buffer + 6, path_length); + + publicKey = public_key_at_given_path(curve_id, bip32_path, path_length); + + if (G_io_apdu_buffer[6 + path_length] != TAG_ARG2) { + THROW(EXC_WRONG_PARAM); + } + + int hash_len = G_io_apdu_buffer[7 + path_length]; + PRINTF(" hash length %d \n", hash_len); + if (hash_len != HASH_LEN) { + THROW(EXC_WRONG_PARAM); + } + + memcpy(msg_hash, G_io_apdu_buffer + 8 + path_length, HASH_LEN); + PRINTF("msg hash copied %02x %02x %02x %02x\n", msg_hash[0], msg_hash[1], msg_hash[30], msg_hash[31]); + + private_key_at_given_path(curve_id, bip32_path, path_length); + + PRINTF("private key fetched\n"); + + display_text_part(); + ui_text(); + flags |= IO_ASYNCH_REPLY; + } break; + + case INS_GET_PUBLIC_KEY: { + + cx_ecfp_public_key_t publicKey; + cx_curve_t curve_id = curve_code_to_curve(G_io_apdu_buffer[3]); + + int path_length = G_io_apdu_buffer[4]; + unsigned char bip32_path[path_length]; + + memcpy(bip32_path, G_io_apdu_buffer + 5, path_length); + + publicKey = public_key_at_given_path(curve_id, bip32_path, path_length); + + os_memmove(G_io_apdu_buffer, publicKey.W, 65); + tx = 65; + THROW(EXC_NO_ERROR); + } break; + + case 0xFF: // return to dashboard + goto return_to_dashboard; + + default: + THROW(EXC_INVALID_INS); + break; + } + } + CATCH_OTHER(e) { + switch (e & 0xF000) { + case 0x6000: + case 0x9000: + sw = e; + break; + default: + sw = 0x6800 | (e & 0x7FF); + break; + } + // Unexpected exception => report + G_io_apdu_buffer[tx] = sw >> 8; + G_io_apdu_buffer[tx + 1] = sw; + tx += 2; + } + FINALLY { + } + } + END_TRY; + } + +return_to_dashboard: + return; +} diff --git a/c/src/signer/ledger-nano/firmware/src/apdu.h b/c/src/signer/ledger-nano/firmware/src/apdu.h new file mode 100755 index 000000000..af777ce65 --- /dev/null +++ b/c/src/signer/ledger-nano/firmware/src/apdu.h @@ -0,0 +1,16 @@ +#pragma once + +#include "globals.h" + +#define CLA 0x80 +#define INS_SIGN 0x02 +#define INS_GET_PUBLIC_KEY 0x04 + + +#define TAG_ARG1 0X01 +#define TAG_ARG2 0X02 + +#define P1_LAST 0x80 +#define P1_MORE 0x00 + +void main_loop(); diff --git a/c/src/signer/ledger-nano/firmware/src/error_codes.h b/c/src/signer/ledger-nano/firmware/src/error_codes.h new file mode 100755 index 000000000..57318827b --- /dev/null +++ b/c/src/signer/ledger-nano/firmware/src/error_codes.h @@ -0,0 +1,4 @@ +#pragma once + +#define SUCCESS 0 +#define WRONG_TAG_BYTE 1 diff --git a/c/src/signer/ledger-nano/firmware/src/exception.h b/c/src/signer/ledger-nano/firmware/src/exception.h new file mode 100755 index 000000000..73f35561c --- /dev/null +++ b/c/src/signer/ledger-nano/firmware/src/exception.h @@ -0,0 +1,18 @@ +#pragma once + +// Throw this to indicate prompting +#define ASYNC_EXCEPTION 0x2000 +#define EXC_WRONG_PARAM 0x6B00 +#define EXC_WRONG_PARAM_P1P2 0x6A86 +#define EXC_WRONG_LENGTH 0x6C00 +#define EXC_INVALID_INS 0x6D00 +#define EXC_WRONG_LENGTH_FOR_INS 0x917E +#define EXC_REJECT 0x6985 +#define EXC_PARSE_ERROR 0x9405 +#define EXC_WRONG_VALUES 0x6A80 +#define EXC_SECURITY 0x6982 +#define EXC_HID_REQUIRED 0x6983 +#define EXC_CLASS 0x6E00 +#define EXC_NO_ERROR 0x9000 +#define EXC_MEMORY_ERROR 0x9200 +#define EXC_NO_UUID_STORED 0x6988 diff --git a/c/src/signer/ledger-nano/firmware/src/globals.h b/c/src/signer/ledger-nano/firmware/src/globals.h new file mode 100755 index 000000000..999e2557b --- /dev/null +++ b/c/src/signer/ledger-nano/firmware/src/globals.h @@ -0,0 +1,39 @@ +#pragma once + +#include "os.h" +#include "cx.h" +#include +#include "exception.h" +#include "os_io_seproxyhal.h" +#include +#include +#include "error_codes.h" + +// data stored in non volatile flash memory,prefix N_ is mandatory to store in flash +extern WIDE nvram_data N_data_real; + + + +extern nvram_data new_data; + + +#define N_data (*(WIDE nvram_data*)PIC(&N_data_real)) + + + +extern unsigned int current_text_pos; // parsing cursor in the text to display +extern unsigned int text_y; // current location of the displayed text +extern cx_sha256_t hash; +extern unsigned char msg_hash[HASH_LEN]; +extern cx_ecfp_private_key_t private_key; + +//bip32 path stored after apdu request parsing +extern unsigned int path[BIP32_PATH_LEN_MAX]; +extern int path_len_bip; + +// ui currently displayed +enum UI_STATE { UI_IDLE, UI_TEXT, UI_APPROVAL }; + +extern enum UI_STATE uiState; + +extern char lineBuffer[100]; diff --git a/c/src/signer/ledger-nano/firmware/src/glyphs.h b/c/src/signer/ledger-nano/firmware/src/glyphs.h new file mode 100644 index 000000000..e69de29bb diff --git a/c/src/signer/ledger-nano/firmware/src/main.c b/c/src/signer/ledger-nano/firmware/src/main.c new file mode 100755 index 000000000..ad07ecb60 --- /dev/null +++ b/c/src/signer/ledger-nano/firmware/src/main.c @@ -0,0 +1,64 @@ +/******************************************************************************* + * Ledger Blue + * (c) 2016 Ledger + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + ********************************************************************************/ +#include "apdu.h" +#include "globals.h" +#include "menu.h" +#include "ui.h" + +unsigned char G_io_seproxyhal_spi_buffer[IO_SEPROXYHAL_BUFFER_SIZE_B]; + +__attribute__((section(".boot"))) int main(void) { + // exit critical section + __asm volatile("cpsie i"); + + current_text_pos = 0; + text_y = 60; + // hashTainted = 1; + uiState = UI_IDLE; + + // ensure exception will work as planned + os_boot(); + + UX_INIT(); + + BEGIN_TRY { + TRY { + io_seproxyhal_init(); + +#ifdef LISTEN_BLE + if (os_seph_features() & + SEPROXYHAL_TAG_SESSION_START_EVENT_FEATURE_BLE) { + BLE_power(0, NULL); + // restart IOs + BLE_power(1, NULL); + } +#endif + + USB_power(0); + USB_power(1); + + ui_idle(); + + main_loop(); + } + CATCH_OTHER(e) { + } + FINALLY { + } + } + END_TRY; +} diff --git a/c/src/signer/ledger-nano/firmware/src/menu.c b/c/src/signer/ledger-nano/firmware/src/menu.c new file mode 100755 index 000000000..bf0f110d8 --- /dev/null +++ b/c/src/signer/ledger-nano/firmware/src/menu.c @@ -0,0 +1,133 @@ +#include "menu.h" + +#include "operations.h" +#include "ui.h" + +unsigned int current_text_pos; // parsing cursor in the text to display +unsigned int text_y; +enum UI_STATE uiState; +char lineBuffer[100]; + +unsigned char display_text_part() { + PRINTF("display_text_part: enter\n"); + unsigned int i; + + // WIDE char* text = (char*) G_io_apdu_buffer + 5; + // PRINTF("display_text_part: text pointer %d %d\n", G_io_apdu_buffer[4], current_text_pos); + // if (text[current_text_pos] == '\0') { + // PRINTF("display_text_part: returning null\n"); + // return 0; + // } + // i = 0; + // while ((text[current_text_pos] != 0) && (text[current_text_pos] != '\n') && + // (i < MAX_CHARS_PER_LINE)) { + // PRINTF("display_text_part: counter %d \n", current_text_pos); + // lineBuffer[i++] = text[current_text_pos]; + // current_text_pos++; + // } + // if (text[current_text_pos] == '\n') { + // current_text_pos++; + // } + tohex(msg_hash, HASH_LEN, lineBuffer, sizeof(lineBuffer)); + current_text_pos = HASH_LEN * 2; + lineBuffer[current_text_pos] = NULL; +#ifdef TARGET_BLUE + os_memset(bagl_ui_text, 0, sizeof(bagl_ui_text)); + bagl_ui_text[0].component.type = BAGL_LABEL; + bagl_ui_text[0].component.x = 4; + bagl_ui_text[0].component.y = text_y; + bagl_ui_text[0].component.width = 320; + bagl_ui_text[0].component.height = TEXT_HEIGHT; + + bagl_ui_text[0].component.fgcolor = 0x000000; + bagl_ui_text[0].component.bgcolor = 0xf9f9f9; + bagl_ui_text[0].component.font_id = DEFAULT_FONT; + bagl_ui_text[0].text = lineBuffer; + text_y += TEXT_HEIGHT + TEXT_SPACE; +#endif + + PRINTF("display_text_part:exit"); + return 0; +} + +void ui_idle(void) { + uiState = UI_IDLE; +#ifdef TARGET_BLUE + UX_DISPLAY(bagl_ui_idle_blue, NULL); +#else + UX_DISPLAY(bagl_ui_idle_nanos, NULL); +#endif +} + +void ui_text(void) { + uiState = UI_TEXT; +#ifdef TARGET_BLUE + UX_DISPLAY(bagl_ui_text, NULL); +#else + UX_DISPLAY(bagl_ui_text_review_nanos, NULL); +#endif +} + +void ui_approval(void) { + uiState = UI_APPROVAL; +#ifdef TARGET_BLUE + UX_DISPLAY(bagl_ui_approval_blue, NULL); +#else + UX_DISPLAY(bagl_ui_approval_nanos, NULL); +#endif +} + +unsigned char io_event(unsigned char channel) { + // nothing done with the event, throw an error on the transport layer if + // needed + + // can't have more than one tag in the reply, //PRINTF ("io_event:enter"); not supported yet. + switch (G_io_seproxyhal_spi_buffer[0]) { + case SEPROXYHAL_TAG_FINGER_EVENT: + UX_FINGER_EVENT(G_io_seproxyhal_spi_buffer); + break; + + case SEPROXYHAL_TAG_BUTTON_PUSH_EVENT: // for Nano S + UX_BUTTON_PUSH_EVENT(G_io_seproxyhal_spi_buffer); + break; + + case SEPROXYHAL_TAG_DISPLAY_PROCESSED_EVENT: + if ((uiState == UI_TEXT) && + (os_seph_features() & + SEPROXYHAL_TAG_SESSION_START_EVENT_FEATURE_SCREEN_BIG)) { + if (!display_text_part()) { + //PRINTF ("io_event:display_text_part"); + ui_approval(); + } else { + UX_REDISPLAY(); + } + } else { + UX_DISPLAYED_EVENT(); + } + break; + + case SEPROXYHAL_TAG_TICKER_EVENT: +#ifdef TARGET_NANOS + UX_TICKER_EVENT(G_io_seproxyhal_spi_buffer, { + // defaulty retrig very soon (will be overriden during + // stepper_prepro) + UX_CALLBACK_SET_INTERVAL(500); + UX_REDISPLAY(); + }); +#endif + break; + + // unknown events are acknowledged + default: + UX_DEFAULT_EVENT(); + break; + } + + // close the event if not done previously (by a display or whatever) + if (!io_seproxyhal_spi_is_status_sent()) { + io_seproxyhal_general_status(); + } + + // command has been processed, DO NOT reset the current APDU transport + return 1; +} diff --git a/c/src/signer/ledger-nano/firmware/src/menu.h b/c/src/signer/ledger-nano/firmware/src/menu.h new file mode 100755 index 000000000..4ff0bf390 --- /dev/null +++ b/c/src/signer/ledger-nano/firmware/src/menu.h @@ -0,0 +1,13 @@ +#pragma once + +#include "globals.h" + +unsigned char display_text_part(); + +void ui_idle(void); + +void ui_text(void); + +void ui_approval(void); + +unsigned char io_event(unsigned char channel); diff --git a/c/src/signer/ledger-nano/firmware/src/operations.c b/c/src/signer/ledger-nano/firmware/src/operations.c new file mode 100755 index 000000000..93fddfa3f --- /dev/null +++ b/c/src/signer/ledger-nano/firmware/src/operations.c @@ -0,0 +1,178 @@ +#include "operations.h" + +#include "apdu.h" +#include "menu.h" + +cx_sha256_t hash; +unsigned int path[BIP32_PATH_LEN_MAX]; +int path_len_bip; +unsigned char msg_hash[HASH_LEN]; +cx_ecfp_private_key_t private_key; + +//static const unsigned int path__[5]= {44|0x80000000, 60|0x80000000, 0|0x80000000, 0, 0}; + +//function to get public key at the given path +cx_ecfp_public_key_t public_key_at_given_path(cx_curve_t curve_id, unsigned char* loc, int path_len) { + PRINTF("public_key_at_given_path:enter"); + cx_ecfp_public_key_t public_key; + cx_ecfp_private_key_t private_key; + unsigned char private_key_data[32]; + path_len_bip = read_bip32_path(path_len, loc, path); + + os_perso_derive_node_bip32(CX_CURVE_256K1, path, path_len_bip, private_key_data, NULL); + + cx_ecdsa_init_private_key(CX_CURVE_256K1, private_key_data, 32, &private_key); + + cx_ecfp_generate_pair(CX_CURVE_256K1, &public_key, &private_key, 1); + + PRINTF("public_key_at_given_path:exit"); + return public_key; +} + +//function to get private key at the given path +cx_ecfp_private_key_t private_key_at_given_path(cx_curve_t curve_id, unsigned char* loc, int path_len) { + cx_ecfp_public_key_t public_key; + unsigned char private_key_data[32]; + path_len_bip = read_bip32_path(path_len, loc, path); + os_perso_derive_node_bip32(CX_CURVE_256K1, path, path_len_bip, private_key_data, NULL); + cx_ecdsa_init_private_key(CX_CURVE_256K1, private_key_data, 32, &private_key); + cx_ecfp_generate_pair(CX_CURVE_256K1, &public_key, &private_key, 1); + return private_key; +} + +const bagl_element_t* io_seproxyhal_touch_exit(const bagl_element_t* e) { + // Go back to the dashboard + os_sched_exit(0); + return NULL; // do not redraw the widget +} + +const bagl_element_t* +io_seproxyhal_touch_approve(const bagl_element_t* e) { + unsigned int tx = 0; + cx_curve_t curve_id = curve_code_to_curve(G_io_apdu_buffer[3]); + + if (G_io_apdu_buffer[2] == P1_LAST) { + + unsigned char result[32]; + os_memmove(result, msg_hash, HASH_LEN); + PRINTF("msg hash signed %02x %02x %02x %02x\n", result[0], result[1], result[30], result[31]); + tx = cx_ecdsa_sign((void*) &private_key, CX_RND_RFC6979 | CX_LAST, CX_KECCAK, result, + sizeof(result), G_io_apdu_buffer, NULL); + + G_io_apdu_buffer[0] &= 0xF0; // discard the parity information + } + G_io_apdu_buffer[tx++] = 0x90; + G_io_apdu_buffer[tx++] = 0x00; + // Send back the response, do not restart the event loop + io_exchange(CHANNEL_APDU | IO_RETURN_AFTER_TX, tx); + // Display back the original UX + ui_idle(); + return 0; // do not redraw the widget +} + +const bagl_element_t* io_seproxyhal_touch_deny(const bagl_element_t* e) { + + G_io_apdu_buffer[0] = 0x69; + G_io_apdu_buffer[1] = 0x85; + // Send back the response, do not restart the event loop + io_exchange(CHANNEL_APDU | IO_RETURN_AFTER_TX, 2); + // Display back the original UX + ui_idle(); + return 0; // do not redraw the widget +} + +unsigned short io_exchange_al(unsigned char channel, unsigned short tx_len) { + switch (channel & ~(IO_FLAGS)) { + case CHANNEL_KEYBOARD: + break; + + // multiplexed io exchange over a SPI channel and TLV encapsulated protocol + case CHANNEL_SPI: + if (tx_len) { + io_seproxyhal_spi_send(G_io_apdu_buffer, tx_len); + + if (channel & IO_RESET_AFTER_REPLIED) { + reset(); + } + return 0; // nothing received from the master so far (it's a tx + // transaction) + } else { + return io_seproxyhal_spi_recv(G_io_apdu_buffer, sizeof(G_io_apdu_buffer), 0); + } + + default: + THROW(EXC_WRONG_PARAM); + } + return 0; +} + +void io_seproxyhal_display(const bagl_element_t* element) { + io_seproxyhal_display_default((bagl_element_t*) element); +} + +uint8_t curve_to_curve_code(cx_curve_t curve) { + switch (curve) { + case CX_CURVE_Ed25519: + return IDM_ED; + case CX_CURVE_SECP256K1: + return IDM_SECP256K1; + case CX_CURVE_SECP256R1: + return IDM_SECP256R1; + default: + THROW(EXC_MEMORY_ERROR); + } +} + +cx_curve_t curve_code_to_curve(uint8_t curve_code) { + static const cx_curve_t curves[] = {CX_CURVE_Ed25519, CX_CURVE_SECP256K1, CX_CURVE_SECP256R1}; + if (curve_code > sizeof(curves) / sizeof(*curves)) { + THROW(EXC_WRONG_PARAM); + } + return curves[curve_code]; +} + +int generate_hash(unsigned char* data, int data_len, unsigned char* out_hash) { + PRINTF("generate_hash:enter"); + PRINTF("generate_hash: data len %d %d %d\n", data_len, data[0], data[data_len - 1]); + PRINTF("generate_hash: hash %u hash.header %u out_hash %u\n", hash, hash.header, out_hash); + cx_sha256_init(&hash); + cx_hash(&hash.header, 0, data, data_len, NULL); + int size = cx_hash(&hash.header, CX_LAST, data, 0, out_hash); + PRINTF("\ngenerate_hash: out_hash %d %d \n", out_hash[0], out_hash[HASH_LEN - 1]); + PRINTF("generate_hash:exit"); + return size; +} + +uint32_t read_bip32_path(uint32_t bytes, const uint8_t* buf, uint32_t* bip32_path) { + uint32_t path_length = bytes; + PRINTF(" bytes %d path_length %d ", bytes, path_length); + + for (size_t i = 0; i < path_length; i++) { + //PRINTF("\n buf %d bip32_path %d path__ %d i %d",buf[i],bip32_path[i],path__[i], i); + if (i < 3) + bip32_path[i] = buf[i] | (0x80000000); + else + bip32_path[i] = buf[i] | (0x00000000); + + //PRINTF("\n buf %d bip32_path %d path__ %d i %d \n",buf[i],bip32_path[i],path__[i], i); + } + + return path_length; +} + +void tohex(unsigned char* in, size_t insz, char* out, size_t outsz) { + unsigned char* pin = in; + const char* hex = "0123456789ABCDEF"; + char* pout = out; + for (; pin < in + insz; pout += 3, pin++) { + pout[0] = hex[(*pin >> 4) & 0xF]; + pout[1] = hex[*pin & 0xF]; + + if (pout + 2 - out > outsz) { + /* Better to truncate output string than overflow buffer */ + /* it would be still better to either return a status */ + /* or ensure the target buffer is large enough and it never happen */ + break; + } + } +} \ No newline at end of file diff --git a/c/src/signer/ledger-nano/firmware/src/operations.h b/c/src/signer/ledger-nano/firmware/src/operations.h new file mode 100755 index 000000000..be44a8419 --- /dev/null +++ b/c/src/signer/ledger-nano/firmware/src/operations.h @@ -0,0 +1,26 @@ +#pragma once +#include "globals.h" + +cx_ecfp_private_key_t private_key_at_given_path(cx_curve_t curve_id, unsigned char* loc, int path_len); + +cx_ecfp_public_key_t public_key_at_given_path(cx_curve_t curve_id, unsigned char* loc, int path_len); + +const bagl_element_t* io_seproxyhal_touch_exit(const bagl_element_t* e); + +const bagl_element_t* io_seproxyhal_touch_approve(const bagl_element_t* e); + +const bagl_element_t* io_seproxyhal_touch_deny(const bagl_element_t* e); + +unsigned short io_exchange_al(unsigned char channel, unsigned short tx_len); + +void io_seproxyhal_display(const bagl_element_t* element); + +uint8_t curve_to_curve_code(cx_curve_t curve); + +cx_curve_t curve_code_to_curve(uint8_t curve_code); + +int generate_hash(unsigned char* data, int data_len, unsigned char* out_hash); + +uint32_t read_bip32_path(uint32_t bytes, const uint8_t* buf, uint32_t* bip32_path); + +void tohex(unsigned char* in, size_t insz, char* out, size_t outsz); diff --git a/c/src/signer/ledger-nano/firmware/src/types.h b/c/src/signer/ledger-nano/firmware/src/types.h new file mode 100755 index 000000000..faf8bc500 --- /dev/null +++ b/c/src/signer/ledger-nano/firmware/src/types.h @@ -0,0 +1,29 @@ +#pragma once + +#define CX_CURVE_256K1 CX_CURVE_SECP256K1 +#define HASH_LEN 0x20 +#define BIP32_PATH_LEN_MAX 0x14 +#define MAX_CHARS_PER_LINE 49 +#define DEFAULT_FONT BAGL_FONT_OPEN_SANS_LIGHT_16px | BAGL_FONT_ALIGNMENT_LEFT +#define TEXT_HEIGHT 15 +#define TEXT_SPACE 4 + +typedef unsigned char uchar_t; + +typedef enum MODULES { + SIGN = 1, + GET_PUBLIC_KEY = 2, +} MODULES; + +typedef enum { + IDM_ED = 0, + IDM_SECP256K1 = 1, + IDM_SECP256R1 = 2, + IDM_NO_CURVE = 255, +} curve_code; + +typedef struct { + cx_curve_t curve; + uint8_t path_length; + uint32_t bip32_path[BIP32_PATH_LEN_MAX]; +} nvram_data; diff --git a/c/src/signer/ledger-nano/firmware/src/ui.c b/c/src/signer/ledger-nano/firmware/src/ui.c new file mode 100755 index 000000000..f85b99e44 --- /dev/null +++ b/c/src/signer/ledger-nano/firmware/src/ui.c @@ -0,0 +1,69 @@ +#include "ui.h" + +#include "menu.h" +#include "operations.h" + +unsigned int +bagl_ui_approval_blue_button(unsigned int button_mask, + unsigned int button_mask_counter) { + return 0; +} + +unsigned int +bagl_ui_idle_blue_button(unsigned int button_mask, + unsigned int button_mask_counter) { + return 0; +} + +unsigned int +bagl_ui_text_button(unsigned int button_mask, + unsigned int button_mask_counter) { + return 0; +} + +unsigned int +bagl_ui_idle_nanos_button(unsigned int button_mask, + unsigned int button_mask_counter) { + switch (button_mask) { + case BUTTON_EVT_RELEASED | BUTTON_LEFT: + case BUTTON_EVT_RELEASED | BUTTON_LEFT | BUTTON_RIGHT: + io_seproxyhal_touch_exit(NULL); + break; + } + + return 0; +} + +unsigned int +bagl_ui_approval_nanos_button(unsigned int button_mask, + unsigned int button_mask_counter) { + switch (button_mask) { + case BUTTON_EVT_RELEASED | BUTTON_RIGHT: + io_seproxyhal_touch_approve(NULL); + break; + + case BUTTON_EVT_RELEASED | BUTTON_LEFT: + io_seproxyhal_touch_deny(NULL); + break; + } + return 0; +} + +unsigned int +bagl_ui_text_review_nanos_button(unsigned int button_mask, + unsigned int button_mask_counter) { + switch (button_mask) { + case BUTTON_EVT_RELEASED | BUTTON_RIGHT: + if (!display_text_part()) { + ui_approval(); + } else { + UX_REDISPLAY(); + } + break; + + case BUTTON_EVT_RELEASED | BUTTON_LEFT: + io_seproxyhal_touch_deny(NULL); + break; + } + return 0; +} diff --git a/c/src/signer/ledger-nano/firmware/src/ui.h b/c/src/signer/ledger-nano/firmware/src/ui.h new file mode 100755 index 000000000..9f3dacc64 --- /dev/null +++ b/c/src/signer/ledger-nano/firmware/src/ui.h @@ -0,0 +1,254 @@ +#pragma once + +#include "globals.h" + +#ifdef TARGET_BLUE + +// UI to approve or deny the signature proposal +static const bagl_element_t const bagl_ui_approval_blue[] = { + + { + {BAGL_BUTTON | BAGL_FLAG_TOUCHABLE, 0x00, 190, 215, 120, 40, 0, 6, + BAGL_FILL, 0x41ccb4, 0xF9F9F9, BAGL_FONT_OPEN_SANS_LIGHT_14px | BAGL_FONT_ALIGNMENT_CENTER | BAGL_FONT_ALIGNMENT_MIDDLE, 0}, + "Deny", + 0, + 0x37ae99, + 0xF9F9F9, + io_seproxyhal_touch_deny, + NULL, + NULL, + }, + { + {BAGL_BUTTON | BAGL_FLAG_TOUCHABLE, 0x00, 190, 265, 120, 40, 0, 6, + BAGL_FILL, 0x41ccb4, 0xF9F9F9, BAGL_FONT_OPEN_SANS_LIGHT_14px | BAGL_FONT_ALIGNMENT_CENTER | BAGL_FONT_ALIGNMENT_MIDDLE, 0}, + "Approve", + 0, + 0x37ae99, + 0xF9F9F9, + io_seproxyhal_touch_approve, + NULL, + NULL, + }, +}; + +unsigned int +bagl_ui_approval_blue_button(unsigned int button_mask, + unsigned int button_mask_counter); + +// UI displayed when no signature proposal has been received +static const bagl_element_t bagl_ui_idle_blue[] = { + + { + {BAGL_RECTANGLE, 0x00, 0, 60, 320, 420, 0, 0, BAGL_FILL, 0xf9f9f9, + 0xf9f9f9, 0, 0}, + NULL, + 0, + 0, + 0, + NULL, + NULL, + NULL, + }, + { + {BAGL_RECTANGLE, 0x00, 0, 0, 320, 60, 0, 0, BAGL_FILL, 0x1d2028, + 0x1d2028, 0, 0}, + NULL, + 0, + 0, + 0, + NULL, + NULL, + NULL, + }, + { + {BAGL_LABEL, 0x00, 20, 0, 320, 60, 0, 0, BAGL_FILL, 0xFFFFFF, 0x1d2028, + BAGL_FONT_OPEN_SANS_LIGHT_14px | BAGL_FONT_ALIGNMENT_MIDDLE, 0}, + "Sample Sign", + 0, + 0, + 0, + NULL, + NULL, + NULL, + }, + { + {BAGL_BUTTON | BAGL_FLAG_TOUCHABLE, 0x00, 190, 215, 120, 40, 0, 6, + BAGL_FILL, 0x41ccb4, 0xF9F9F9, BAGL_FONT_OPEN_SANS_LIGHT_14px | BAGL_FONT_ALIGNMENT_CENTER | BAGL_FONT_ALIGNMENT_MIDDLE, 0}, + "Exit", + 0, + 0x37ae99, + 0xF9F9F9, + io_seproxyhal_touch_exit, + NULL, + NULL, + }, +}; + +unsigned int +bagl_ui_idle_blue_button(unsigned int button_mask, + unsigned int button_mask_counter); + +static bagl_element_t bagl_ui_text[1]; + +unsigned int +bagl_ui_text_button(unsigned int button_mask, + unsigned int button_mask_counter); + +#else + +static const bagl_element_t bagl_ui_idle_nanos[] = { + + { + {BAGL_RECTANGLE, 0x00, 0, 0, 128, 32, 0, 0, BAGL_FILL, 0x000000, + 0xFFFFFF, 0, 0}, + NULL, + 0, + 0, + 0, + NULL, + NULL, + NULL, + }, + { + {BAGL_LABELINE, 0x02, 0, 12, 128, 11, 0, 0, 0, 0xFFFFFF, 0x000000, + BAGL_FONT_OPEN_SANS_REGULAR_11px | BAGL_FONT_ALIGNMENT_CENTER, 0}, + "Waiting for message", + 0, + 0, + 0, + NULL, + NULL, + NULL, + }, + { + {BAGL_ICON, 0x00, 3, 12, 7, 7, 0, 0, 0, 0xFFFFFF, 0x000000, 0, + BAGL_GLYPH_ICON_CROSS}, + NULL, + 0, + 0, + 0, + NULL, + NULL, + NULL, + }, +}; + +unsigned int +bagl_ui_idle_nanos_button(unsigned int button_mask, + unsigned int button_mask_counter); + +static const bagl_element_t bagl_ui_approval_nanos[] = { + + { + {BAGL_RECTANGLE, 0x00, 0, 0, 128, 32, 0, 0, BAGL_FILL, 0x000000, + 0xFFFFFF, 0, 0}, + NULL, + 0, + 0, + 0, + NULL, + NULL, + NULL, + }, + { + {BAGL_LABELINE, 0x02, 0, 12, 128, 11, 0, 0, 0, 0xFFFFFF, 0x000000, + BAGL_FONT_OPEN_SANS_REGULAR_11px | BAGL_FONT_ALIGNMENT_CENTER, 0}, + "Sign message", + 0, + 0, + 0, + NULL, + NULL, + NULL, + }, + { + {BAGL_ICON, 0x00, 3, 12, 7, 7, 0, 0, 0, 0xFFFFFF, 0x000000, 0, + BAGL_GLYPH_ICON_CROSS}, + NULL, + 0, + 0, + 0, + NULL, + NULL, + NULL, + }, + { + {BAGL_ICON, 0x00, 117, 13, 8, 6, 0, 0, 0, 0xFFFFFF, 0x000000, 0, + BAGL_GLYPH_ICON_CHECK}, + NULL, + 0, + 0, + 0, + NULL, + NULL, + NULL, + }, +}; + +unsigned int +bagl_ui_approval_nanos_button(unsigned int button_mask, + unsigned int button_mask_counter); + +static const bagl_element_t bagl_ui_text_review_nanos[] = { + + { + {BAGL_RECTANGLE, 0x00, 0, 0, 128, 32, 0, 0, BAGL_FILL, 0x000000, + 0xFFFFFF, 0, 0}, + NULL, + 0, + 0, + 0, + NULL, + NULL, + NULL, + }, + { + {BAGL_LABELINE, 0x02, 0, 12, 128, 11, 0, 0, 0, 0xFFFFFF, 0x000000, + BAGL_FONT_OPEN_SANS_REGULAR_11px | BAGL_FONT_ALIGNMENT_CENTER, 0}, + "Verify text", + 0, + 0, + 0, + NULL, + NULL, + NULL, + }, + { + {BAGL_LABELINE, 0x02, 23, 26, 82, 11, 0x80 | 10, 0, 0, 0xFFFFFF, + 0x000000, BAGL_FONT_OPEN_SANS_EXTRABOLD_11px | BAGL_FONT_ALIGNMENT_CENTER, 26}, + lineBuffer, + 0, + 0, + 0, + NULL, + NULL, + NULL, + }, + { + {BAGL_ICON, 0x00, 3, 12, 7, 7, 0, 0, 0, 0xFFFFFF, 0x000000, 0, + BAGL_GLYPH_ICON_CROSS}, + NULL, + 0, + 0, + 0, + NULL, + NULL, + NULL, + }, + { + {BAGL_ICON, 0x00, 117, 13, 8, 6, 0, 0, 0, 0xFFFFFF, 0x000000, 0, + BAGL_GLYPH_ICON_CHECK}, + NULL, + 0, + 0, + 0, + NULL, + NULL, + NULL, + }, +}; + +unsigned int +bagl_ui_text_review_nanos_button(unsigned int button_mask, + unsigned int button_mask_counter); +#endif diff --git a/c/src/signer/ledger-nano/signer/CMakeLists.txt b/c/src/signer/ledger-nano/signer/CMakeLists.txt new file mode 100644 index 000000000..1c050216b --- /dev/null +++ b/c/src/signer/ledger-nano/signer/CMakeLists.txt @@ -0,0 +1,59 @@ +############################################################################### +# This file is part of the Incubed project. +# Sources: https://github.com/slockit/in3-c +# +# Copyright (C) 2018-2020 slock.it GmbH, Blockchains LLC +# +# +# COMMERCIAL LICENSE USAGE +# +# Licensees holding a valid commercial license may use this file in accordance +# with the commercial license agreement provided with the Software or, alternatively, +# in accordance with the terms contained in a written agreement between you and +# slock.it GmbH/Blockchains LLC. For licensing terms and conditions or further +# information please contact slock.it at in3@slock.it. +# +# Alternatively, this file may be used under the AGPL license as follows: +# +# AGPL LICENSE USAGE +# +# This program is free software: you can redistribute it and/or modify it under the +# terms of the GNU Affero General Public License as published by the Free Software +# Foundation, either version 3 of the License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, but WITHOUT ANY +# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A +# PARTICULAR PURPOSE. See the GNU Affero General Public License for more details. +# [Permissions of this strong copyleft license are conditioned on making available +# complete source code of licensed works and modifications, which include larger +# works using a licensed work, under the same license. Copyright and license notices +# must be preserved. Contributors provide an express grant of patent rights.] +# You should have received a copy of the GNU Affero General Public License along +# with this program. If not, see . +############################################################################### +#cmake_minimum_required(VERSION 3.15) +include("${PROJECT_SOURCE_DIR}/c/compiler.cmake") + +if(UNIX AND NOT APPLE) + set(LINUX TRUE) +endif() + +add_library(ledger_signer_o OBJECT ledger_signer.c device_apdu_commands.c) +target_compile_definitions(ledger_signer_o PRIVATE -D_POSIX_C_SOURCE=199309L) +add_library(ledger_signer STATIC $) + + +if(APPLE) + target_link_libraries(ledger_signer ${CMAKE_LIBRARY_OUTPUT_DIRECTORY}/${CMAKE_SHARED_LIBRARY_PREFIX}hidapi${CMAKE_SHARED_LIBRARY_SUFFIX} ${LIBS}) +elseif(LINUX) + target_link_libraries(ledger_signer ${CMAKE_LIBRARY_OUTPUT_DIRECTORY}/libhidapi-hidraw${CMAKE_SHARED_LIBRARY_SUFFIX} ${LIBS}) +elseif(WIN32) + # not building for windows currently + # target_link_libraries(ledger_signer ${CMAKE_LIBRARY_OUTPUT_DIRECTORY}/${CMAKE_SHARED_LIBRARY_PREFIX}hidapi${CMAKE_SHARED_LIBRARY_SUFFIX} ${LIBS}) +else() + target_link_libraries(ledger_signer ${CMAKE_LIBRARY_OUTPUT_DIRECTORY}/libhidapi-hidraw${CMAKE_SHARED_LIBRARY_SUFFIX} ${LIBS}) +endif() + +if(NOT WIN32) + add_dependencies(ledger_signer lib-hidapi) +endif() \ No newline at end of file diff --git a/c/src/signer/ledger-nano/signer/device_apdu_commands.c b/c/src/signer/ledger-nano/signer/device_apdu_commands.c new file mode 100644 index 000000000..5e20e4bcf --- /dev/null +++ b/c/src/signer/ledger-nano/signer/device_apdu_commands.c @@ -0,0 +1,77 @@ +#ifdef WIN32 +#include +#endif + +#include "../../../core/util/log.h" +#include "../../../third-party/hidapi/hidapi/hidapi.h" +#include "device_apdu_commands.h" +#include +#include +#include + +static uint8_t CHANNEL[] = {0x01, 0x01}; + +const uint8_t CLA = 0x80; +const uint8_t INS_GET_PUBLIC_KEY = 0x04; +const uint8_t INS_SIGN = 0x02; +const uint8_t P1_MORE = 0x00; +const uint8_t P1_FINAL = 0X80; +const uint8_t P2_FINAL = 0X00; +const uint8_t TAG = 0x05; + +void wrap_apdu(bytes_t i_apdu, uint16_t seq, bytes_t* o_wrapped_hid_cmd) { + + uint16_t apdu_len = (uint16_t) i_apdu.len; + uint8_t data[2]; + int index = 0; + uint8_t cmd[HID_CMD_MAX_LEN]; + + memset(cmd + index, 0x00, sizeof(cmd)); + + memcpy(cmd + index, CHANNEL, sizeof(CHANNEL)); + index += sizeof(CHANNEL); + + memcpy(cmd + index, &TAG, 1); + index += 1; + + len_to_bytes(seq, data); + in3_log_debug("data[0] %d data[1] %d\n", data[0], data[1]); + memcpy(cmd + index, data, sizeof(data)); + index += sizeof(data); + + len_to_bytes(apdu_len, data); + in3_log_debug("data[0] %d data[1] %d\n", data[0], data[1]); + memcpy(cmd + index, data, sizeof(data)); + index += sizeof(data); + + memcpy(cmd + index, i_apdu.data, i_apdu.len); + + o_wrapped_hid_cmd->len = HID_CMD_MAX_LEN; + o_wrapped_hid_cmd->data = malloc(HID_CMD_MAX_LEN); + + memcpy(o_wrapped_hid_cmd->data, cmd, HID_CMD_MAX_LEN); +} + +void unwrap_apdu(bytes_t i_wrapped_hid_cmd, bytes_t* o_apdu_res) { + uint8_t buf[2]; + buf[0] = i_wrapped_hid_cmd.data[5]; + buf[1] = i_wrapped_hid_cmd.data[6]; + + int len = bytes_to_len(buf); + + o_apdu_res->len = len; + o_apdu_res->data = malloc(len); + memcpy(o_apdu_res->data, len, i_wrapped_hid_cmd.data + 7); +} + +int len_to_bytes(uint16_t x, uint8_t* buf) { + + buf[1] = (uint8_t)(x & 0xFF); + buf[0] = (uint8_t)((x >> 8) & 0xFF); + return 2; +} + +uint16_t bytes_to_len(uint8_t* buf) { + uint16_t number = (buf[1] << 8) + buf[0]; + return number; +} diff --git a/c/src/signer/ledger-nano/signer/device_apdu_commands.h b/c/src/signer/ledger-nano/signer/device_apdu_commands.h new file mode 100644 index 000000000..346e38b8e --- /dev/null +++ b/c/src/signer/ledger-nano/signer/device_apdu_commands.h @@ -0,0 +1,57 @@ +/******************************************************************************* + * This file is part of the Incubed project. + * Sources: https://github.com/slockit/in3-c + * + * Copyright (C) 2018-2020 slock.it GmbH, Blockchains LLC + * + * + * COMMERCIAL LICENSE USAGE + * + * Licensees holding a valid commercial license may use this file in accordance + * with the commercial license agreement provided with the Software or, alternatively, + * in accordance with the terms contained in a written agreement between you and + * slock.it GmbH/Blockchains LLC. For licensing terms and conditions or further + * information please contact slock.it at in3@slock.it. + * + * Alternatively, this file may be used under the AGPL license as follows: + * + * AGPL LICENSE USAGE + * + * This program is free software: you can redistribute it and/or modify it under the + * terms of the GNU Affero General Public License as published by the Free Software + * Foundation, either version 3 of the License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, but WITHOUT ANY + * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A + * PARTICULAR PURPOSE. See the GNU Affero General Public License for more details. + * [Permissions of this strong copyleft license are conditioned on making available + * complete source code of licensed works and modifications, which include larger + * works using a licensed work, under the same license. Copyright and license notices + * must be preserved. Contributors provide an express grant of patent rights.] + * You should have received a copy of the GNU Affero General Public License along + * with this program. If not, see . + *******************************************************************************/ + +#ifndef in3_device_apdu_h__ +#define in3_device_apdu_h__ + +#include "../../../core/client/client.h" +#define HID_CMD_MAX_LEN 64 + +extern const uint8_t CLA; +extern const uint8_t INS_GET_PUBLIC_KEY; +extern const uint8_t INS_SIGN; +extern const uint8_t P1_MORE; +extern const uint8_t P1_FINAL; +extern const uint8_t P2_FINAL; +extern const uint8_t TAG; + +int len_to_bytes(uint16_t x, uint8_t* buf); + +uint16_t bytes_to_len(uint8_t* buf); + +void wrap_apdu(bytes_t i_apdu, uint16_t seq, bytes_t* o_wrapped_hid_cmd); + +void unwrap_apdu(bytes_t o_wrapped_hid_cmd, bytes_t* o_apdu_res); + +#endif \ No newline at end of file diff --git a/c/src/signer/ledger-nano/signer/ledger_signer.c b/c/src/signer/ledger-nano/signer/ledger_signer.c new file mode 100644 index 000000000..a7ce879c1 --- /dev/null +++ b/c/src/signer/ledger-nano/signer/ledger_signer.c @@ -0,0 +1,316 @@ +#ifdef WIN32 +#include +#endif + +#include "../../../core/client/context.h" +#include "../../../core/util/bytes.h" +#include "../../../core/util/log.h" +#include "device_apdu_commands.h" +#include "ledger_signer.h" +#include "ledger_signer_priv.h" + +#include +#include +#include + +#define MAX_STR 255 + +in3_ret_t is_ledger_device_connected() { + int res = 0; + in3_ret_t ret; + wchar_t wstr[MAX_STR]; + + res = hid_init(); + hid_device* handle; + + handle = hid_open(LEDGER_NANOS_VID, LEDGER_NANOS_PID, NULL); + + if (NULL != handle) { + in3_log_info("device connected \n"); + + res = hid_get_manufacturer_string(handle, wstr, MAX_STR); + in3_log_debug("device manufacturer: %ls\n", wstr); + + hid_get_product_string(handle, wstr, MAX_STR); + in3_log_debug("product: %ls\n", wstr); + + ret = IN3_OK; + } else { + ret = IN3_ENODEVICE; + } + + hid_close(handle); + res = hid_exit(); + + return ret; +} + +in3_ret_t eth_get_address_from_path(bytes_t i_bip_path, bytes_t o_address) { + //not implemented currently + return IN3_EUNKNOWN; +} + +in3_ret_t eth_ledger_sign(void* ctx, d_signature_type_t type, bytes_t message, bytes_t account, uint8_t* dst) { + //UNUSED_VAR(account); // at least for now + uint8_t* bip_path_bytes = ((in3_ctx_t*) ctx)->client->signer->wallet; + + uint8_t bip_data[5]; + + int res = 0; + in3_ret_t ret; + + hid_device* handle; + uint8_t apdu[64]; + uint8_t buf[2]; + int index_counter = 0; + uint8_t bytes_read = 0; + + uint8_t msg_len = 32; + uint8_t hash[32]; + uint8_t read_buf[255]; + + bool is_hashed = false; + bytes_t apdu_bytes; + bytes_t final_apdu_command; + uint8_t public_key[65]; + bytes_t response; + + memcpy(bip_data, bip_path_bytes, sizeof(bip_data)); + + ret = eth_ledger_get_public_key(bip_data, public_key); + res = hid_init(); + handle = hid_open(LEDGER_NANOS_VID, LEDGER_NANOS_PID, NULL); + int cmd_size = 64; + int recid = 0; + + if (NULL != handle) { + + hid_set_nonblocking(handle, 0); + + switch (type) { + case SIGN_EC_RAW: + memcpy(hash, message.data, message.len); + is_hashed = true; + case SIGN_EC_HASH: + if (!is_hashed) + hasher_Raw(HASHER_SHA3K, message.data, message.len, hash); + + apdu[index_counter++] = CLA; + apdu[index_counter++] = INS_SIGN; + apdu[index_counter++] = P1_FINAL; + apdu[index_counter++] = IDM_SECP256K1; + + apdu[index_counter++] = 0x01; //1st arg tag + apdu[index_counter++] = sizeof(bip_data); + memcpy(apdu + index_counter, &bip_data, sizeof(bip_data)); + index_counter += sizeof(bip_data); + + apdu[index_counter++] = 0x02; //2nd arg tag + apdu[index_counter++] = msg_len; + memcpy(apdu + index_counter, hash, msg_len); + index_counter += msg_len; + + apdu_bytes.data = malloc(index_counter); + apdu_bytes.len = index_counter; + memcpy(apdu_bytes.data, apdu, index_counter); + + wrap_apdu(apdu_bytes, 0, &final_apdu_command); + +#ifdef DEBUG + in3_log_debug("apdu commnd sent to device\n"); + ba_print(final_apdu_command.data, final_apdu_command.len); +#endif + + res = hid_write(handle, final_apdu_command.data, final_apdu_command.len); + + in3_log_debug("written to hid %d\n", res); + + read_hid_response(handle, &response); + +#ifdef DEBUG + in3_log_debug("response received from device\n"); + ba_print(response.data, response.len); +#endif + + if (response.data[response.len - 2] == 0x90 && response.data[response.len - 1] == 0x00) { + ret = IN3_OK; + + in3_log_debug("apdu executed succesfully \n"); + extract_signture(response, dst); + recid = get_recid_from_pub_key(&secp256k1, public_key, dst, hash); + dst[64] = recid; + +#ifdef DEBUG + in3_log_debug("printing signature returned by device with recid value\n"); + ba_print(dst, 65); +#endif + + } else { + in3_log_fatal("error in apdu execution \n"); + ret = IN3_ENOTSUP; + } + + free(final_apdu_command.data); + free(apdu_bytes.data); + ret = IN3_OK; + break; + + default: + return IN3_ENOTSUP; + } + + } else { + in3_log_fatal("no ledger device connected \n"); + ret = IN3_ENODEVICE; + } + hid_close(handle); + res = hid_exit(); + return 65; +} + +in3_ret_t eth_ledger_get_public_key(uint8_t* i_bip_path, uint8_t* o_public_key) { + int res = 0; + in3_ret_t ret; + uint8_t apdu[64]; + uint8_t buf[2]; + int index_counter = 0; + uint16_t msg_len = 0; + uint8_t bytes_read = 0; + + bytes_t apdu_bytes; + bytes_t final_apdu_command; + bytes_t response; + hid_device* handle; + + res = hid_init(); + handle = hid_open(LEDGER_NANOS_VID, LEDGER_NANOS_PID, NULL); + if (NULL != handle) { + apdu[index_counter++] = CLA; + apdu[index_counter++] = INS_GET_PUBLIC_KEY; + apdu[index_counter++] = P1_FINAL; + apdu[index_counter++] = IDM_SECP256K1; + + apdu[index_counter++] = 5; + memcpy(apdu + index_counter, i_bip_path, 5); + index_counter += 5; + + apdu_bytes.data = malloc(index_counter); + apdu_bytes.len = index_counter; + memcpy(apdu_bytes.data, apdu, index_counter); + + wrap_apdu(apdu_bytes, 0, &final_apdu_command); + + res = hid_write(handle, final_apdu_command.data, final_apdu_command.len); + + read_hid_response(handle, &response); + +#ifdef DEBUG + in3_log_debug("response received from device\n"); + ba_print(response.data, response.len); +#endif + + if (response.data[response.len - 2] == 0x90 && response.data[response.len - 1] == 0x00) { + ret = IN3_OK; + memcpy(o_public_key, response.data, response.len - 2); + } else { + ret = IN3_ENOTSUP; + } + free(final_apdu_command.data); + free(apdu_bytes.data); + free(response.data); + + } else { + ret = IN3_ENODEVICE; + } + hid_close(handle); + res = hid_exit(); + return ret; +} + +in3_ret_t eth_ledger_set_signer(in3_t* in3, uint8_t* bip_path) { + if (in3->signer) free(in3->signer); + in3->signer = malloc(sizeof(in3_signer_t)); + in3->signer->sign = eth_ledger_sign; + in3->signer->prepare_tx = NULL; + in3->signer->wallet = bip_path; + return IN3_OK; +} + +void extract_signture(bytes_t i_raw_sig, uint8_t* o_sig) { + + //ECDSA signature encoded as TLV: 30 L 02 Lr r 02 Ls s + int lr = i_raw_sig.data[3]; + int ls = i_raw_sig.data[lr + 5]; + int offset = 0; + in3_log_debug("lr %d, ls %d \n", lr, ls); + if (lr > 0x20) { + memcpy(o_sig + offset, i_raw_sig.data + 5, lr - 1); + offset = lr - 1; + } else { + memcpy(o_sig, i_raw_sig.data + 4, lr); + offset = lr; + } + + if (ls > 0x20) { + memcpy(o_sig + offset, i_raw_sig.data + lr + 7, ls - 1); + } else { + memcpy(o_sig + offset, i_raw_sig.data + lr + 6, ls); + } +} + +void read_hid_response(hid_device* handle, bytes_t* response) { + uint8_t read_chunk[64]; + uint8_t read_buf[255]; + int index_counter = 0; + int bytes_to_read = 0; + int total_bytes_available = 0; + int bytes_read = 0; + do { + bytes_read = hid_read(handle, read_chunk, sizeof(read_chunk)); + + if (bytes_read > 0) { + + if (index_counter == 0) //first chunk read + { + total_bytes_available = read_chunk[6]; + index_counter += (bytes_read - 7); + + memcpy(read_buf, read_chunk + 7, bytes_read - 7); + } else { + memcpy(read_buf + index_counter, read_chunk + 5, total_bytes_available - index_counter); + index_counter += (bytes_read - 5); + } + bytes_to_read = total_bytes_available - index_counter; + } + if (bytes_to_read <= 0) { + break; + } + + } while (bytes_read > 0); + + response->len = total_bytes_available; + response->data = malloc(total_bytes_available); + memcpy(response->data, read_buf, total_bytes_available); +} + +int get_recid_from_pub_key(const ecdsa_curve* curve, uint8_t* pub_key, const uint8_t* sig, const uint8_t* digest) { + + int i = 0; + uint8_t p_key[65]; + int ret = 0; + int recid = -1; + for (i = 0; i < 4; i++) { + ret = ecdsa_recover_pub_from_sig(curve, p_key, sig, digest, i); + if (ret == 0) { + if (memcmp(pub_key, p_key, 65) == 0) { + recid = i; +#ifdef DEBUG + in3_log_debug("public key matched with recid value\n"); + ba_print(p_key, 65, "get_recid_from_pub_key :keys matched"); +#endif + break; + } + } + } + return recid; +} \ No newline at end of file diff --git a/c/src/signer/ledger-nano/signer/ledger_signer.h b/c/src/signer/ledger-nano/signer/ledger_signer.h new file mode 100644 index 000000000..89e720e8b --- /dev/null +++ b/c/src/signer/ledger-nano/signer/ledger_signer.h @@ -0,0 +1,51 @@ +/******************************************************************************* + * This file is part of the Incubed project. + * Sources: https://github.com/slockit/in3-c + * + * Copyright (C) 2018-2020 slock.it GmbH, Blockchains LLC + * + * + * COMMERCIAL LICENSE USAGE + * + * Licensees holding a valid commercial license may use this file in accordance + * with the commercial license agreement provided with the Software or, alternatively, + * in accordance with the terms contained in a written agreement between you and + * slock.it GmbH/Blockchains LLC. For licensing terms and conditions or further + * information please contact slock.it at in3@slock.it. + * + * Alternatively, this file may be used under the AGPL license as follows: + * + * AGPL LICENSE USAGE + * + * This program is free software: you can redistribute it and/or modify it under the + * terms of the GNU Affero General Public License as published by the Free Software + * Foundation, either version 3 of the License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, but WITHOUT ANY + * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A + * PARTICULAR PURPOSE. See the GNU Affero General Public License for more details. + * [Permissions of this strong copyleft license are conditioned on making available + * complete source code of licensed works and modifications, which include larger + * works using a licensed work, under the same license. Copyright and license notices + * must be preserved. Contributors provide an express grant of patent rights.] + * You should have received a copy of the GNU Affero General Public License along + * with this program. If not, see . + *******************************************************************************/ + +// @PUBLIC_HEADER +/** @file + * this file defines the incubed configuration struct and it registration. + * + * + * */ + +#ifndef in3_ledger_signer_h__ +#define in3_ledger_signer_h__ + +#include "../../../core/client/client.h" + +in3_ret_t eth_ledger_set_signer(in3_t* in3, uint8_t* bip_path); +in3_ret_t eth_ledger_get_public_key(uint8_t* i_bip_path, uint8_t* o_public_key); +in3_ret_t eth_ledger_sign(void* ctx, d_signature_type_t type, bytes_t message, bytes_t account, uint8_t* dst); + +#endif \ No newline at end of file diff --git a/c/src/signer/ledger-nano/signer/ledger_signer_priv.h b/c/src/signer/ledger-nano/signer/ledger_signer_priv.h new file mode 100644 index 000000000..008c6bbe2 --- /dev/null +++ b/c/src/signer/ledger-nano/signer/ledger_signer_priv.h @@ -0,0 +1,59 @@ +/******************************************************************************* + * This file is part of the Incubed project. + * Sources: https://github.com/slockit/in3-c + * + * Copyright (C) 2018-2020 slock.it GmbH, Blockchains LLC + * + * + * COMMERCIAL LICENSE USAGE + * + * Licensees holding a valid commercial license may use this file in accordance + * with the commercial license agreement provided with the Software or, alternatively, + * in accordance with the terms contained in a written agreement between you and + * slock.it GmbH/Blockchains LLC. For licensing terms and conditions or further + * information please contact slock.it at in3@slock.it. + * + * Alternatively, this file may be used under the AGPL license as follows: + * + * AGPL LICENSE USAGE + * + * This program is free software: you can redistribute it and/or modify it under the + * terms of the GNU Affero General Public License as published by the Free Software + * Foundation, either version 3 of the License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, but WITHOUT ANY + * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A + * PARTICULAR PURPOSE. See the GNU Affero General Public License for more details. + * [Permissions of this strong copyleft license are conditioned on making available + * complete source code of licensed works and modifications, which include larger + * works using a licensed work, under the same license. Copyright and license notices + * must be preserved. Contributors provide an express grant of patent rights.] + * You should have received a copy of the GNU Affero General Public License along + * with this program. If not, see . + *******************************************************************************/ +#ifndef in3_ledger_signer_priv_h__ +#define in3_ledger_signer_priv_h__ + +#include "../../../core/client/client.h" +#include "../../../third-party/crypto/ecdsa.h" +#include "../../../third-party/crypto/secp256k1.h" +#include "../../../third-party/hidapi/hidapi/hidapi.h" + +#define LEDGER_NANOS_VID 0x2C97 +#define LEDGER_NANOS_PID 0x1001 + +typedef enum CURVE_CODE_ { + IDM_ED = 0, + IDM_SECP256K1 = 1, + IDM_SECP256R1 = 2, + IDM_NO_CURVE = 255, +} CURVE_CODE; + +void extract_signture(bytes_t i_raw_sig, uint8_t* o_sig); +void read_hid_response(hid_device* handle, bytes_t* response); +int get_recid_from_pub_key(const ecdsa_curve* curve, uint8_t* pub_key, const uint8_t* sig, const uint8_t* digest); +in3_ret_t is_ledger_device_connected(); + +in3_ret_t eth_get_address_from_path(bytes_t i_bip_path, bytes_t o_address); + +#endif \ No newline at end of file diff --git a/c/src/third-party/CMakeLists.txt b/c/src/third-party/CMakeLists.txt index a0c111730..a93da3eb2 100644 --- a/c/src/third-party/CMakeLists.txt +++ b/c/src/third-party/CMakeLists.txt @@ -47,3 +47,7 @@ endif() if (IPFS) add_subdirectory( libb64 ) endif() + +if (HIDAPI) + add_subdirectory( hidapi ) +endif() diff --git a/c/src/third-party/hidapi/.appveyor.yml b/c/src/third-party/hidapi/.appveyor.yml new file mode 100644 index 000000000..b7e21c764 --- /dev/null +++ b/c/src/third-party/hidapi/.appveyor.yml @@ -0,0 +1,33 @@ +os: Visual Studio 2015 + +environment: + matrix: + - BUILD_ENV: msbuild + arch: x64 + - BUILD_ENV: msbuild + arch: Win32 + - BUILD_ENV: cygwin + +install: + - cmd: if %BUILD_ENV%==cygwin ( + C:\cygwin64\setup-x86_64.exe --quiet-mode --no-shortcuts --upgrade-also --packages autoconf,automake ) + +build_script: + - cmd: if %BUILD_ENV%==msbuild ( + msbuild .\windows\hidapi.sln /p:Configuration=Release /p:Platform=%arch% /logger:"C:\Program Files\AppVeyor\BuildAgent\Appveyor.MSBuildLogger.dll" ) + - cmd: if %BUILD_ENV%==cygwin ( + C:\cygwin64\bin\bash -exlc "cd $APPVEYOR_BUILD_FOLDER; ./bootstrap; ./configure; make" ) + +artifacts: + # Win32 artifacts + - path: .\windows\Release\hidapi.dll + - path: .\windows\Release\hidapi.lib + - path: .\windows\Release\hidapi.pdb + - path: .\windows\Release\hidtest.exe + - path: .\windows\Release\hidtest.pdb + # x64 artifacts + - path: .\windows\x64\Release\hidapi.dll + - path: .\windows\x64\Release\hidapi.lib + - path: .\windows\x64\Release\hidapi.pdb + - path: .\windows\x64\Release\hidtest.exe + - path: .\windows\x64\Release\hidtest.pdb diff --git a/c/src/third-party/hidapi/.builds/alpine.yml b/c/src/third-party/hidapi/.builds/alpine.yml new file mode 100644 index 000000000..9477671aa --- /dev/null +++ b/c/src/third-party/hidapi/.builds/alpine.yml @@ -0,0 +1,25 @@ +image: alpine/edge +packages: +- autoconf +- automake +- libtool +- eudev-dev +- libusb-dev +- linux-headers +sources: +- https://github.com/libusb/hidapi +tasks: +- setup: | + cd hidapi + ./bootstrap + ./configure +- build: | + cd hidapi + make + make DESTDIR=$PWD/root install + make clean +- build-manual: | + cd hidapi/linux + make -f Makefile-manual + cd ../libusb + make -f Makefile-manual diff --git a/c/src/third-party/hidapi/.builds/archlinux.yml b/c/src/third-party/hidapi/.builds/archlinux.yml new file mode 100644 index 000000000..e98996d42 --- /dev/null +++ b/c/src/third-party/hidapi/.builds/archlinux.yml @@ -0,0 +1,18 @@ +image: archlinux +sources: +- https://github.com/libusb/hidapi +tasks: +- setup: | + cd hidapi + ./bootstrap + ./configure +- build: | + cd hidapi + make + make DESTDIR=$PWD/root install + make clean +- build-manual: | + cd hidapi/linux + make -f Makefile-manual + cd ../libusb + make -f Makefile-manual diff --git a/c/src/third-party/hidapi/.builds/fedora-mingw.yml b/c/src/third-party/hidapi/.builds/fedora-mingw.yml new file mode 100644 index 000000000..4effecf32 --- /dev/null +++ b/c/src/third-party/hidapi/.builds/fedora-mingw.yml @@ -0,0 +1,22 @@ +image: fedora/latest +packages: +- autoconf +- automake +- libtool +- mingw64-gcc +- mingw64-gcc-c++ +sources: +- https://github.com/libusb/hidapi +tasks: +- setup: | + cd hidapi + ./bootstrap + mingw64-configure +- build: | + cd hidapi + make + make DESTDIR=$PWD/root install + make clean +- build-manual: | + cd hidapi/windows + make -f Makefile-manual OS=MINGW CC=x86_64-w64-mingw32-gcc diff --git a/c/src/third-party/hidapi/.builds/freebsd.yml b/c/src/third-party/hidapi/.builds/freebsd.yml new file mode 100644 index 000000000..355dc4930 --- /dev/null +++ b/c/src/third-party/hidapi/.builds/freebsd.yml @@ -0,0 +1,23 @@ +image: freebsd/latest +packages: +- autoconf +- automake +- gmake +- libiconv +- libtool +- pkgconf +sources: +- https://github.com/libusb/hidapi +tasks: +- setup: | + cd hidapi + ./bootstrap + ./configure +- build: | + cd hidapi + make + make DESTDIR=$PWD/root install + make clean +- build-manual: | + cd hidapi/libusb + gmake -f Makefile-manual diff --git a/c/src/third-party/hidapi/.cirrus.yml b/c/src/third-party/hidapi/.cirrus.yml new file mode 100644 index 000000000..b4cf20166 --- /dev/null +++ b/c/src/third-party/hidapi/.cirrus.yml @@ -0,0 +1,33 @@ +alpine_task: + container: + image: alpine:latest + install_script: apk add autoconf automake g++ gcc libusb-dev libtool linux-headers eudev-dev make musl-dev + script: + - ./bootstrap + - ./configure || { cat config.log; exit 1; } + - make + - make install + +freebsd11_task: + freebsd_instance: + image: freebsd-11-2-release-amd64 + install_script: + - pkg install -y + autoconf automake libiconv libtool pkgconf + script: + - ./bootstrap + - ./configure || { cat config.log; exit 1; } + - make + - make install + +freebsd12_task: + freebsd_instance: + image: freebsd-12-1-release-amd64 + install_script: + - pkg install -y + autoconf automake libiconv libtool pkgconf + script: + - ./bootstrap + - ./configure || { cat config.log; exit 1; } + - make + - make install diff --git a/c/src/third-party/hidapi/.gitattributes b/c/src/third-party/hidapi/.gitattributes new file mode 100644 index 000000000..edb79febc --- /dev/null +++ b/c/src/third-party/hidapi/.gitattributes @@ -0,0 +1,7 @@ +* text=auto + +*.sln text eol=crlf +*.vcproj text eol=crlf + +bootstrap text eol=lf +configure.ac text eol=lf diff --git a/c/src/third-party/hidapi/.gitignore b/c/src/third-party/hidapi/.gitignore new file mode 100644 index 000000000..8438c4b81 --- /dev/null +++ b/c/src/third-party/hidapi/.gitignore @@ -0,0 +1,22 @@ + +# Autotools-added generated files +Makefile.in +aclocal.m4 +ar-lib +autom4te.cache/ +config.* +configure +compile +depcomp +install-sh +libusb/Makefile.in +linux/Makefile.in +ltmain.sh +mac/Makefile.in +missing +testgui/Makefile.in +windows/Makefile.in + +Makefile +stamp-h1 +libtool diff --git a/c/src/third-party/hidapi/.travis.yml b/c/src/third-party/hidapi/.travis.yml new file mode 100644 index 000000000..80367e94c --- /dev/null +++ b/c/src/third-party/hidapi/.travis.yml @@ -0,0 +1,13 @@ +language: c + +os: osx +osx_image: xcode10.2 + +script: + - ./bootstrap + - ./configure + - make + - make DESTDIR=$PWD/root install + - make clean + - cd mac + - make -f Makefile-manual diff --git a/c/src/third-party/hidapi/AUTHORS.txt b/c/src/third-party/hidapi/AUTHORS.txt new file mode 100644 index 000000000..e08cb1619 --- /dev/null +++ b/c/src/third-party/hidapi/AUTHORS.txt @@ -0,0 +1,18 @@ + +HIDAPI Authors: + +Alan Ott : + Original Author and Maintainer + Linux, Windows, and Mac implementations + +Ludovic Rousseau : + Formatting for Doxygen documentation + Bug fixes + Correctness fixes + +libusb/hidapi Team: + Development/maintainance since June 4th 2019 + +For a comprehensive list of contributions, see the commit list at github: + https://github.com/libusb/hidapi/commits/master + diff --git a/c/src/third-party/hidapi/CMakeLists.txt b/c/src/third-party/hidapi/CMakeLists.txt new file mode 100644 index 000000000..f5d08535e --- /dev/null +++ b/c/src/third-party/hidapi/CMakeLists.txt @@ -0,0 +1,48 @@ +############################################################################### +# This file is part of the Incubed project. +# Sources: https://github.com/slockit/in3-c +# +# Copyright (C) 2018-2020 slock.it GmbH, Blockchains LLC +# +# +# COMMERCIAL LICENSE USAGE +# +# Licensees holding a valid commercial license may use this file in accordance +# with the commercial license agreement provided with the Software or, alternatively, +# in accordance with the terms contained in a written agreement between you and +# slock.it GmbH/Blockchains LLC. For licensing terms and conditions or further +# information please contact slock.it at in3@slock.it. +# +# Alternatively, this file may be used under the AGPL license as follows: +# +# AGPL LICENSE USAGE +# +# This program is free software: you can redistribute it and/or modify it under the +# terms of the GNU Affero General Public License as published by the Free Software +# Foundation, either version 3 of the License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, but WITHOUT ANY +# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A +# PARTICULAR PURPOSE. See the GNU Affero General Public License for more details. +# [Permissions of this strong copyleft license are conditioned on making available +# complete source code of licensed works and modifications, which include larger +# works using a licensed work, under the same license. Copyright and license notices +# must be preserved. Contributors provide an express grant of patent rights.] +# You should have received a copy of the GNU Affero General Public License along +# with this program. If not, see . +############################################################################### + +include(ExternalProject) +set(HIDAPI_DIR ${CMAKE_CURRENT_SOURCE_DIR}) +set(HIDAPI_BIN ${CMAKE_CURRENT_BINARY_DIR}) + + +ExternalProject_Add( + lib-hidapi + SOURCE_DIR ${HIDAPI_DIR}/hidapi + DOWNLOAD_COMMAND "" + CONFIGURE_COMMAND cd ${HIDAPI_DIR} && ./bootstrap && ./configure --srcdir=${HIDAPI_DIR} --prefix=${CMAKE_BINARY_DIR} + BUILD_COMMAND cd ${HIDAPI_DIR} && make + INSTALL_COMMAND cd ${HIDAPI_DIR} && make install +) + diff --git a/c/src/third-party/hidapi/HACKING.txt b/c/src/third-party/hidapi/HACKING.txt new file mode 100644 index 000000000..761d4b655 --- /dev/null +++ b/c/src/third-party/hidapi/HACKING.txt @@ -0,0 +1,15 @@ +This file is mostly for the maintainer. + +1. Build hidapi.dll +2. Build hidtest.exe in DEBUG and RELEASE +3. Commit all + +4. Run the Following + export VERSION=0.1.0 + export TAG_NAME=hidapi-$VERSION + git tag $TAG_NAME + git archive --format zip --prefix $TAG_NAME/ $TAG_NAME >../$TAG_NAME.zip +5. Test the zip file. +6. Run the following: + git push origin $TAG_NAME + diff --git a/c/src/third-party/hidapi/LICENSE-bsd.txt b/c/src/third-party/hidapi/LICENSE-bsd.txt new file mode 100644 index 000000000..538cdf95c --- /dev/null +++ b/c/src/third-party/hidapi/LICENSE-bsd.txt @@ -0,0 +1,26 @@ +Copyright (c) 2010, Alan Ott, Signal 11 Software +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + + * Redistributions of source code must retain the above copyright notice, + this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. + * Neither the name of Signal 11 Software nor the names of its + contributors may be used to endorse or promote products derived from + this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE +LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +POSSIBILITY OF SUCH DAMAGE. diff --git a/c/src/third-party/hidapi/LICENSE-gpl3.txt b/c/src/third-party/hidapi/LICENSE-gpl3.txt new file mode 100644 index 000000000..94a9ed024 --- /dev/null +++ b/c/src/third-party/hidapi/LICENSE-gpl3.txt @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/c/src/third-party/hidapi/LICENSE-orig.txt b/c/src/third-party/hidapi/LICENSE-orig.txt new file mode 100644 index 000000000..e3f338082 --- /dev/null +++ b/c/src/third-party/hidapi/LICENSE-orig.txt @@ -0,0 +1,9 @@ + HIDAPI - Multi-Platform library for + communication with HID devices. + + Copyright 2009, Alan Ott, Signal 11 Software. + All Rights Reserved. + + This software may be used by anyone for any reason so + long as the copyright notice in the source files + remains intact. diff --git a/c/src/third-party/hidapi/LICENSE.txt b/c/src/third-party/hidapi/LICENSE.txt new file mode 100644 index 000000000..e1676d4c4 --- /dev/null +++ b/c/src/third-party/hidapi/LICENSE.txt @@ -0,0 +1,13 @@ +HIDAPI can be used under one of three licenses. + +1. The GNU General Public License, version 3.0, in LICENSE-gpl3.txt +2. A BSD-Style License, in LICENSE-bsd.txt. +3. The more liberal original HIDAPI license. LICENSE-orig.txt + +The license chosen is at the discretion of the user of HIDAPI. For example: +1. An author of GPL software would likely use HIDAPI under the terms of the +GPL. + +2. An author of commercial closed-source software would likely use HIDAPI +under the terms of the BSD-style license or the original HIDAPI license. + diff --git a/c/src/third-party/hidapi/Makefile.am b/c/src/third-party/hidapi/Makefile.am new file mode 100644 index 000000000..00bcb73cf --- /dev/null +++ b/c/src/third-party/hidapi/Makefile.am @@ -0,0 +1,85 @@ + +ACLOCAL_AMFLAGS = -I m4 + +if OS_FREEBSD +pkgconfigdir=$(prefix)/libdata/pkgconfig +else +pkgconfigdir=$(libdir)/pkgconfig +endif + +if OS_LINUX +pkgconfig_DATA=pc/hidapi-hidraw.pc pc/hidapi-libusb.pc +else +pkgconfig_DATA=pc/hidapi.pc +endif + +SUBDIRS= + +if OS_LINUX +SUBDIRS += linux libusb +endif + +if OS_DARWIN +SUBDIRS += mac +endif + +if OS_FREEBSD +SUBDIRS += libusb +endif + +if OS_KFREEBSD +SUBDIRS += libusb +endif + +if OS_HAIKU +SUBDIRS += libusb +endif + +if OS_WINDOWS +SUBDIRS += windows +endif + +SUBDIRS += hidtest + +if BUILD_TESTGUI +SUBDIRS += testgui +endif + +EXTRA_DIST = udev doxygen + +dist_doc_DATA = \ + README.md \ + AUTHORS.txt \ + LICENSE-bsd.txt \ + LICENSE-gpl3.txt \ + LICENSE-orig.txt \ + LICENSE.txt + +SCMCLEAN_TARGETS= \ + aclocal.m4 \ + config.guess \ + config.sub \ + configure \ + config.h.in \ + depcomp \ + install-sh \ + ltmain.sh \ + missing \ + mac/Makefile.in \ + testgui/Makefile.in \ + libusb/Makefile.in \ + Makefile.in \ + linux/Makefile.in \ + windows/Makefile.in \ + m4/libtool.m4 \ + m4/lt~obsolete.m4 \ + m4/ltoptions.m4 \ + m4/ltsugar.m4 \ + m4/ltversion.m4 + +SCMCLEAN_DIR_TARGETS = \ + autom4te.cache + +scm-clean: distclean + rm -f $(SCMCLEAN_TARGETS) + rm -Rf $(SCMCLEAN_DIR_TARGETS) diff --git a/c/src/third-party/hidapi/README b/c/src/third-party/hidapi/README new file mode 100644 index 000000000..598d4507d --- /dev/null +++ b/c/src/third-party/hidapi/README @@ -0,0 +1,33 @@ +# HIDAPI is being used in the project to communicate with USB and Bluetooth HID devices. +======================================================================================== + + + +1. License +HIDAPI can be used under one of three licenses. + +1. The GNU General Public License, version 3.0, in LICENSE-gpl3.txt +2. A BSD-Style License, in LICENSE-bsd.txt. +3. The more liberal original HIDAPI license. LICENSE-orig.txt + +The license chosen is at the discretion of the user of HIDAPI. For example: +1. An author of GPL software would likely use HIDAPI under the terms of the +GPL. + +2. An author of commercial closed-source software would likely use HIDAPI +under the terms of the BSD-style license or the original HIDAPI license. + +======================================================================================= + +2. Project Source +Ref: https://github.com/libusb/hidapi + +======================================================================================= + +3. We haven't made any changes to original source as of now + +======================================================================================= + +4. Keep watching the original project source and pull latest fixes into this repo if required + +======================================================================================= diff --git a/c/src/third-party/hidapi/README.md b/c/src/third-party/hidapi/README.md new file mode 100644 index 000000000..f5582d7a9 --- /dev/null +++ b/c/src/third-party/hidapi/README.md @@ -0,0 +1,380 @@ +## HIDAPI library for Windows, Linux, FreeBSD and macOS + +| CI instance | Status | +|----------------------|--------| +| `macOS master` | [![Build Status](https://travis-ci.org/libusb/hidapi.svg?branch=master)](https://travis-ci.org/libusb/hidapi) | +| `Windows master` | [![Build status](https://ci.appveyor.com/api/projects/status/r482aevuigmi86rk/branch/master?svg=true)](https://ci.appveyor.com/project/Youw/hidapi/branch/master) | +| `Linux/BSD, last build (branch/PR)` | [![builds.sr.ht status](https://builds.sr.ht/~qbicz/hidapi.svg)](https://builds.sr.ht/~qbicz/hidapi?) | + +HIDAPI is a multi-platform library which allows an application to interface +with USB and Bluetooth HID-Class devices on Windows, Linux, FreeBSD, and macOS. +HIDAPI can be either built as a shared library (`.so`, `.dll` or `.dylib`) or +can be embedded directly into a target application by adding a single source +file (per platform) and a single header. + +HIDAPI library was originally developed by Alan Ott ([signal11](https://github.com/signal11)). + +It was moved to [libusb/hidapi](https://github.com/libusb/hidapi) on June 4th, 2019, in order to merge important bugfixes and continue development of the library. + +## Table of Contents + +* [About](#about) +* [What Does the API Look Like?](#what-does-the-api-look-like) +* [License](#license) +* [Download](#download) +* [Build Instructions](#build-instructions) + * [Prerequisites](#prerequisites) + * [Linux](#linux) + * [FreeBSD](#freebsd) + * [Mac](#mac) + * [Windows](#windows) + * [Building HIDAPI into a shared library on Unix Platforms](#building-hidapi-into-a-shared-library-on-unix-platforms) + * [Building the manual way on Unix platforms](#building-the-manual-way-on-unix-platforms) + * [Building on Windows](#building-on-windows) +* [Cross Compiling](#cross-compiling) + * [Prerequisites](#prerequisites-1) + * [Building HIDAPI](#building-hidapi) + +## About + +HIDAPI has five back-ends: +* Windows (using `hid.dll`) +* Linux/hidraw (using the Kernel's hidraw driver) +* Linux/libusb (using libusb-1.0) +* FreeBSD (using libusb-1.0) +* Mac (using IOHidManager) + +On Linux, either the hidraw or the libusb back-end can be used. There are +tradeoffs, and the functionality supported is slightly different. + +__Linux/hidraw__ (`linux/hid.c`): + +This back-end uses the hidraw interface in the Linux kernel, and supports +both USB and Bluetooth HID devices. It requires kernel version at least 2.6.39 +to build. In addition, it will only communicate with devices which have hidraw +nodes associated with them. +Keyboards, mice, and some other devices which are blacklisted from having +hidraw nodes will not work. Fortunately, for nearly all the uses of hidraw, +this is not a problem. + +__Linux/FreeBSD/libusb__ (`libusb/hid.c`): + +This back-end uses libusb-1.0 to communicate directly to a USB device. This +back-end will of course not work with Bluetooth devices. + +HIDAPI also comes with a Test GUI. The Test GUI is cross-platform and uses +Fox Toolkit . It will build on every platform +which HIDAPI supports. Since it relies on a 3rd party library, building it +is optional but recommended because it is so useful when debugging hardware. + +## What Does the API Look Like? +The API provides the most commonly used HID functions including sending +and receiving of input, output, and feature reports. The sample program, +which communicates with a heavily hacked up version of the Microchip USB +Generic HID sample looks like this (with error checking removed for +simplicity): + +**Warning: Only run the code you understand, and only when it conforms to the +device spec. Writing data at random to your HID devices can break them.** + +```c +#ifdef WIN32 +#include +#endif +#include +#include +#include "hidapi.h" + +#define MAX_STR 255 + +int main(int argc, char* argv[]) +{ + int res; + unsigned char buf[65]; + wchar_t wstr[MAX_STR]; + hid_device *handle; + int i; + + // Initialize the hidapi library + res = hid_init(); + + // Open the device using the VID, PID, + // and optionally the Serial number. + handle = hid_open(0x4d8, 0x3f, NULL); + + // Read the Manufacturer String + res = hid_get_manufacturer_string(handle, wstr, MAX_STR); + wprintf(L"Manufacturer String: %s\n", wstr); + + // Read the Product String + res = hid_get_product_string(handle, wstr, MAX_STR); + wprintf(L"Product String: %s\n", wstr); + + // Read the Serial Number String + res = hid_get_serial_number_string(handle, wstr, MAX_STR); + wprintf(L"Serial Number String: (%d) %s\n", wstr[0], wstr); + + // Read Indexed String 1 + res = hid_get_indexed_string(handle, 1, wstr, MAX_STR); + wprintf(L"Indexed String 1: %s\n", wstr); + + // Toggle LED (cmd 0x80). The first byte is the report number (0x0). + buf[0] = 0x0; + buf[1] = 0x80; + res = hid_write(handle, buf, 65); + + // Request state (cmd 0x81). The first byte is the report number (0x0). + buf[0] = 0x0; + buf[1] = 0x81; + res = hid_write(handle, buf, 65); + + // Read requested state + res = hid_read(handle, buf, 65); + + // Print out the returned buffer. + for (i = 0; i < 4; i++) + printf("buf[%d]: %d\n", i, buf[i]); + + // Close the device + hid_close(handle); + + // Finalize the hidapi library + res = hid_exit(); + + return 0; +} +``` + +You can also use [hidtest/test.c](hidtest/test.c) +as a starting point for your applications. + + +## License +HIDAPI may be used by one of three licenses as outlined in [LICENSE.txt](LICENSE.txt). + +## Download +HIDAPI can be downloaded from GitHub +```sh +git clone git://github.com/libusb/hidapi.git +``` + +## Build Instructions + +This section is long. Don't be put off by this. It's not long because it's +complicated to build HIDAPI; it's quite the opposite. This section is long +because of the flexibility of HIDAPI and the large number of ways in which +it can be built and used. You will likely pick a single build method. + +HIDAPI can be built in several different ways. If you elect to build a +shared library, you will need to build it from the HIDAPI source +distribution. If you choose instead to embed HIDAPI directly into your +application, you can skip the building and look at the provided platform +Makefiles for guidance. These platform Makefiles are located in `linux/`, +`libusb/`, `mac/` and `windows/` and are called `Makefile-manual`. In addition, +Visual Studio projects are provided. Even if you're going to embed HIDAPI +into your project, it is still beneficial to build the example programs. + + +### Prerequisites: + +#### Linux: +On Linux, you will need to install development packages for libudev, +libusb and optionally Fox-toolkit (for the test GUI). On +Debian/Ubuntu systems these can be installed by running: +```sh +sudo apt-get install libudev-dev libusb-1.0-0-dev libfox-1.6-dev +``` + +If you downloaded the source directly from the git repository (using +git clone), you'll need Autotools: +```sh +sudo apt-get install autotools-dev autoconf automake libtool +``` + +#### FreeBSD: +On FreeBSD you will need to install GNU make, libiconv, and +optionally Fox-Toolkit (for the test GUI). This is done by running +the following: +```sh +pkg_add -r gmake libiconv fox16 +``` + +If you downloaded the source directly from the git repository (using +git clone), you'll need Autotools: +```sh +pkg_add -r autotools +``` + +#### Mac: +On Mac, you will need to install Fox-Toolkit if you wish to build +the Test GUI. There are two ways to do this, and each has a slight +complication. Which method you use depends on your use case. + +If you wish to build the Test GUI just for your own testing on your +own computer, then the easiest method is to install Fox-Toolkit +using ports: +```sh +sudo port install fox +``` + +If you wish to build the TestGUI app bundle to redistribute to +others, you will need to install Fox-toolkit from source. This is +because the version of fox that gets installed using ports uses the +ports X11 libraries which are not compatible with the Apple X11 +libraries. If you install Fox with ports and then try to distribute +your built app bundle, it will simply fail to run on other systems. +To install Fox-Toolkit manually, download the source package from +, extract it, and run the following from +within the extracted source: +```sh +./configure && make && make install +``` + +#### Windows: +On Windows, if you want to build the test GUI, you will need to get +the `hidapi-externals.zip` package from the download site. This +contains pre-built binaries for Fox-toolkit. Extract +`hidapi-externals.zip` just outside of hidapi, so that +hidapi-externals and hidapi are on the same level, as shown: +``` + Parent_Folder + | + +hidapi + +hidapi-externals +``` +Again, this step is not required if you do not wish to build the +test GUI. + + +### Building HIDAPI into a shared library on Unix Platforms: + +On Unix-like systems such as Linux, FreeBSD, macOS, and even Windows, using +MinGW or Cygwin, the easiest way to build a standard system-installed shared +library is to use the GNU Autotools build system. If you checked out the +source from the git repository, run the following: + +```sh +./bootstrap +./configure +make +make install # as root, or using sudo +``` + +If you downloaded a source package (i.e.: if you did not run git clone), you +can skip the `./bootstrap` step. + +`./configure` can take several arguments which control the build. The two most +likely to be used are: +```sh + --enable-testgui + Enable build of the Test GUI. This requires Fox toolkit to + be installed. Instructions for installing Fox-Toolkit on + each platform are in the Prerequisites section above. + + --prefix=/usr + Specify where you want the output headers and libraries to + be installed. The example above will put the headers in + /usr/include and the binaries in /usr/lib. The default is to + install into /usr/local which is fine on most systems. +``` +### Building the manual way on Unix platforms: + +Manual Makefiles are provided mostly to give the user and idea what it takes +to build a program which embeds HIDAPI directly inside of it. These should +really be used as examples only. If you want to build a system-wide shared +library, use the Autotools method described above. + +To build HIDAPI using the manual Makefiles, change to the directory +of your platform and run make. For example, on Linux run: +```sh +cd linux/ +make -f Makefile-manual +``` + +To build the Test GUI using the manual makefiles: +```sh +cd testgui/ +make -f Makefile-manual +``` + +### Building on Windows: + +To build the HIDAPI DLL on Windows using Visual Studio, build the `.sln` file +in the `windows/` directory. + +To build the Test GUI on windows using Visual Studio, build the `.sln` file in +the `testgui/` directory. + +To build HIDAPI using MinGW or Cygwin using Autotools, use the instructions +in the section [Building HIDAPI into a shared library on Unix Platforms](#building-hidapi-into-a-shared-library-on-unix-platforms) +above. Note that building the Test GUI with MinGW or Cygwin will +require the Windows procedure in the [Prerequisites](#prerequisites-1) section +above (i.e.: `hidapi-externals.zip`). + +To build HIDAPI using MinGW using the Manual Makefiles, see the section +[Building the manual way on Unix platforms](#building-the-manual-way-on-unix-platforms) +above. + +HIDAPI can also be built using the Windows DDK (now also called the Windows +Driver Kit or WDK). This method was originally required for the HIDAPI build +but not anymore. However, some users still prefer this method. It is not as +well supported anymore but should still work. Patches are welcome if it does +not. To build using the DDK: + + 1. Install the Windows Driver Kit (WDK) from Microsoft. + 2. From the Start menu, in the Windows Driver Kits folder, select Build + Environments, then your operating system, then the x86 Free Build + Environment (or one that is appropriate for your system). + 3. From the console, change directory to the `windows/ddk_build/` directory, + which is part of the HIDAPI distribution. + 4. Type build. + 5. You can find the output files (DLL and LIB) in a subdirectory created + by the build system which is appropriate for your environment. On + Windows XP, this directory is `objfre_wxp_x86/i386`. + +## Cross Compiling + +This section talks about cross compiling HIDAPI for Linux using Autotools. +This is useful for using HIDAPI on embedded Linux targets. These +instructions assume the most raw kind of embedded Linux build, where all +prerequisites will need to be built first. This process will of course vary +based on your embedded Linux build system if you are using one, such as +OpenEmbedded or Buildroot. + +For the purpose of this section, it will be assumed that the following +environment variables are exported. +```sh +$ export STAGING=$HOME/out +$ export HOST=arm-linux +``` + +`STAGING` and `HOST` can be modified to suit your setup. + +### Prerequisites + +Note that the build of libudev is the very basic configuration. + +Build libusb. From the libusb source directory, run: +```sh +./configure --host=$HOST --prefix=$STAGING +make +make install +``` + +Build libudev. From the libudev source directory, run: +```sh +./configure --disable-gudev --disable-introspection --disable-hwdb \ + --host=$HOST --prefix=$STAGING +make +make install +``` + +### Building HIDAPI + +Build HIDAPI: +``` +PKG_CONFIG_DIR= \ +PKG_CONFIG_LIBDIR=$STAGING/lib/pkgconfig:$STAGING/share/pkgconfig \ +PKG_CONFIG_SYSROOT_DIR=$STAGING \ +./configure --host=$HOST --prefix=$STAGING +``` diff --git a/c/src/third-party/hidapi/android/jni/Android.mk b/c/src/third-party/hidapi/android/jni/Android.mk new file mode 100644 index 000000000..527b43fd6 --- /dev/null +++ b/c/src/third-party/hidapi/android/jni/Android.mk @@ -0,0 +1,19 @@ +LOCAL_PATH:= $(call my-dir) + +HIDAPI_ROOT_REL:= ../.. +HIDAPI_ROOT_ABS:= $(LOCAL_PATH)/../.. + +include $(CLEAR_VARS) + +LOCAL_SRC_FILES := \ + $(HIDAPI_ROOT_REL)/libusb/hid.c + +LOCAL_C_INCLUDES += \ + $(HIDAPI_ROOT_ABS)/hidapi \ + $(HIDAPI_ROOT_ABS)/android + +LOCAL_SHARED_LIBRARIES := libusb1.0 + +LOCAL_MODULE := libhidapi + +include $(BUILD_SHARED_LIBRARY) diff --git a/c/src/third-party/hidapi/bootstrap b/c/src/third-party/hidapi/bootstrap new file mode 100755 index 000000000..81e9b74b6 --- /dev/null +++ b/c/src/third-party/hidapi/bootstrap @@ -0,0 +1,2 @@ +#!/bin/sh -x +autoreconf --install --verbose --force diff --git a/c/src/third-party/hidapi/configure.ac b/c/src/third-party/hidapi/configure.ac new file mode 100644 index 000000000..a8f2a84cb --- /dev/null +++ b/c/src/third-party/hidapi/configure.ac @@ -0,0 +1,252 @@ +AC_PREREQ(2.63) + +# Version number. This is currently the only place. +m4_define([HIDAPI_MAJOR], 0) +m4_define([HIDAPI_MINOR], 9) +m4_define([HIDAPI_RELEASE], 0) +m4_define([HIDAPI_RC], ) +m4_define([VERSION_STRING], HIDAPI_MAJOR[.]HIDAPI_MINOR[.]HIDAPI_RELEASE[]HIDAPI_RC) + +AC_INIT([hidapi],[VERSION_STRING],[alan@signal11.us]) + +# Library soname version +# Follow the following rules (particularly the ones in the second link): +# http://www.gnu.org/software/libtool/manual/html_node/Updating-version-info.html +# http://sourceware.org/autobook/autobook/autobook_91.html +lt_current="0" +lt_revision="0" +lt_age="0" +LTLDFLAGS="-version-info ${lt_current}:${lt_revision}:${lt_age}" + +AC_CONFIG_MACRO_DIR([m4]) +AM_INIT_AUTOMAKE([foreign -Wall -Werror]) +AC_CONFIG_MACRO_DIR([m4]) + +m4_ifdef([AM_PROG_AR], [AM_PROG_AR]) +LT_INIT + +AC_PROG_CC +AC_PROG_CXX +AC_PROG_OBJC +PKG_PROG_PKG_CONFIG + + +m4_ifdef([AM_SILENT_RULES], [AM_SILENT_RULES([yes])]) + +hidapi_lib_error() { + echo "" + echo " Library $1 was not found on this system." + echo " Please install it and re-run ./configure" + echo "" + exit 1 +} + +hidapi_prog_error() { + echo "" + echo " Program $1 was not found on this system." + echo " This program is part of $2." + echo " Please install it and re-run ./configure" + echo "" + exit 1 +} + +AC_MSG_CHECKING([operating system]) +AC_MSG_RESULT($host) +case $host in +*-linux*) + AC_MSG_RESULT([ (Linux back-end)]) + AC_DEFINE(OS_LINUX, 1, [Linux implementations]) + AC_SUBST(OS_LINUX) + backend="linux" + os="linux" + threads="pthreads" + + # HIDAPI/hidraw libs + PKG_CHECK_MODULES([libudev], [libudev], true, [hidapi_lib_error libudev]) + LIBS_HIDRAW_PR="${LIBS_HIDRAW_PR} $libudev_LIBS" + CFLAGS_HIDRAW="${CFLAGS_HIDRAW} $libudev_CFLAGS" + + # HIDAPI/libusb libs + AC_CHECK_LIB([rt], [clock_gettime], [LIBS_LIBUSB_PRIVATE="${LIBS_LIBUSB_PRIVATE} -lrt"], [hidapi_lib_error librt]) + PKG_CHECK_MODULES([libusb], [libusb-1.0 >= 1.0.9], true, [hidapi_lib_error libusb-1.0]) + LIBS_LIBUSB_PRIVATE="${LIBS_LIBUSB_PRIVATE} $libusb_LIBS" + CFLAGS_LIBUSB="${CFLAGS_LIBUSB} $libusb_CFLAGS" + ;; +*-darwin*) + AC_MSG_RESULT([ (Mac OS X back-end)]) + AC_DEFINE(OS_DARWIN, 1, [Mac implementation]) + AC_SUBST(OS_DARWIN) + backend="mac" + os="darwin" + threads="pthreads" + LIBS="${LIBS} -framework IOKit -framework CoreFoundation" + ;; +*-freebsd*) + AC_MSG_RESULT([ (FreeBSD back-end)]) + AC_DEFINE(OS_FREEBSD, 1, [FreeBSD implementation]) + AC_SUBST(OS_FREEBSD) + backend="libusb" + os="freebsd" + threads="pthreads" + + CFLAGS="$CFLAGS -I/usr/local/include" + LDFLAGS="$LDFLAGS -L/usr/local/lib" + LIBS="${LIBS}" + PKG_CHECK_MODULES([libusb], [libusb-1.0 >= 1.0.9], true, [hidapi_lib_error libusb-1.0]) + LIBS_LIBUSB_PRIVATE="${LIBS_LIBUSB_PRIVATE} $libusb_LIBS" + CFLAGS_LIBUSB="${CFLAGS_LIBUSB} $libusb_CFLAGS" + AC_CHECK_LIB([iconv], [iconv_open], [LIBS_LIBUSB_PRIVATE="${LIBS_LIBUSB_PRIVATE} -liconv"], [hidapi_lib_error libiconv]) + ;; +*-kfreebsd*) + AC_MSG_RESULT([ (kFreeBSD back-end)]) + AC_DEFINE(OS_KFREEBSD, 1, [kFreeBSD implementation]) + AC_SUBST(OS_KFREEBSD) + backend="libusb" + os="kfreebsd" + threads="pthreads" + + PKG_CHECK_MODULES([libusb], [libusb-1.0 >= 1.0.9], true, [hidapi_lib_error libusb-1.0]) + LIBS_LIBUSB_PRIVATE="${LIBS_LIBUSB_PRIVATE} $libusb_LIBS" + CFLAGS_LIBUSB="${CFLAGS_LIBUSB} $libusb_CFLAGS" + ;; +*-*-haiku) + AC_MSG_RESULT([ (Haiku back-end)]) + AC_DEFINE(OS_HAIKU, 1, [Haiku implementation]) + AC_SUBST(OS_HAIKU) + backend="libusb" + os="haiku" + threads="pthreads" + + PKG_CHECK_MODULES([libusb], [libusb-1.0 >= 1.0.9], true, [hidapi_lib_error libusb-1.0]) + LIBS_LIBUSB_PRIVATE="${LIBS_LIBUSB_PRIVATE} $libusb_LIBS" + CFLAGS_LIBUSB="${CFLAGS_LIBUSB} $libusb_CFLAGS" + AC_CHECK_LIB([iconv], [libiconv_open], [LIBS_LIBUSB_PRIVATE="${LIBS_LIBUSB_PRIVATE} -liconv"], [hidapi_lib_error libiconv]) + ;; +*-mingw*) + AC_MSG_RESULT([ (Windows back-end, using MinGW)]) + backend="windows" + os="windows" + threads="windows" + win_implementation="mingw" + ;; +*-cygwin*) + AC_MSG_RESULT([ (Windows back-end, using Cygwin)]) + backend="windows" + os="windows" + threads="windows" + win_implementation="cygwin" + ;; +*) + AC_MSG_ERROR([HIDAPI is not supported on your operating system yet]) +esac + +LIBS_HIDRAW="${LIBS} ${LIBS_HIDRAW_PR}" +LIBS_LIBUSB="${LIBS} ${LIBS_LIBUSB_PRIVATE}" +AC_SUBST([LIBS_HIDRAW]) +AC_SUBST([LIBS_LIBUSB]) +AC_SUBST([CFLAGS_LIBUSB]) +AC_SUBST([CFLAGS_HIDRAW]) + +if test "x$os" = xwindows; then + AC_DEFINE(OS_WINDOWS, 1, [Windows implementations]) + AC_SUBST(OS_WINDOWS) + LDFLAGS="${LDFLAGS} -no-undefined" + LIBS="${LIBS} -lsetupapi" +fi + +if test "x$threads" = xpthreads; then + AX_PTHREAD([found_pthreads=yes], [found_pthreads=no]) + + if test "x$found_pthreads" = xyes; then + if test "x$os" = xlinux; then + # Only use pthreads for libusb implementation on Linux. + LIBS_LIBUSB="$PTHREAD_LIBS $LIBS_LIBUSB" + CFLAGS_LIBUSB="$CFLAGS_LIBUSB $PTHREAD_CFLAGS" + # There's no separate CC on Linux for threading, + # so it's ok that both implementations use $PTHREAD_CC + CC="$PTHREAD_CC" + else + LIBS="$PTHREAD_LIBS $LIBS" + CFLAGS="$CFLAGS $PTHREAD_CFLAGS" + CC="$PTHREAD_CC" + fi + fi +fi + +# Test GUI +AC_ARG_ENABLE([testgui], + [AS_HELP_STRING([--enable-testgui], + [enable building of test GUI (default n)])], + [testgui_enabled=$enableval], + [testgui_enabled='no']) +AM_CONDITIONAL([BUILD_TESTGUI], [test "x$testgui_enabled" != "xno"]) + +# Configure the MacOS TestGUI app bundle +rm -Rf testgui/TestGUI.app +mkdir -p testgui/TestGUI.app +cp -R ${srcdir}/testgui/TestGUI.app.in/* testgui/TestGUI.app +chmod -R u+w testgui/TestGUI.app +mkdir testgui/TestGUI.app/Contents/MacOS/ + +if test "x$testgui_enabled" != "xno"; then + if test "x$os" = xdarwin; then + # On Mac OS, don't use pkg-config. + AC_CHECK_PROG([foxconfig], [fox-config], [fox-config], false) + if test "x$foxconfig" = "xfalse"; then + hidapi_prog_error fox-config "FOX Toolkit" + fi + LIBS_TESTGUI="${LIBS_TESTGUI} `$foxconfig --libs`" + LIBS_TESTGUI="${LIBS_TESTGUI} -framework Cocoa -L/usr/X11R6/lib" + CFLAGS_TESTGUI="${CFLAGS_TESTGUI} `$foxconfig --cflags`" + OBJCFLAGS="${OBJCFLAGS} -x objective-c++" + elif test "x$os" = xwindows; then + # On Windows, just set the paths for Fox toolkit + if test "x$win_implementation" = xmingw; then + CFLAGS_TESTGUI="-I\$(srcdir)/../../hidapi-externals/fox/include -g -c" + LIBS_TESTGUI=" -mwindows \$(srcdir)/../../hidapi-externals/fox/lib/libFOX-1.6.a -lgdi32 -Wl,--enable-auto-import -static-libgcc -static-libstdc++ -lkernel32" + else + # Cygwin + CFLAGS_TESTGUI="-DWIN32 -I\$(srcdir)/../../hidapi-externals/fox/include -g -c" + LIBS_TESTGUI="\$(srcdir)/../../hidapi-externals/fox/lib/libFOX-cygwin-1.6.a -lgdi32 -Wl,--enable-auto-import -static-libgcc -static-libstdc++ -lkernel32" + fi + else + # On Linux and FreeBSD platforms, use pkg-config to find fox. + PKG_CHECK_MODULES([fox], [fox17], [], [PKG_CHECK_MODULES([fox], [fox])]) + LIBS_TESTGUI="${LIBS_TESTGUI} $fox_LIBS" + if test "x$os" = xfreebsd; then + LIBS_TESTGUI="${LIBS_TESTGUI} -L/usr/local/lib" + fi + CFLAGS_TESTGUI="${CFLAGS_TESTGUI} $fox_CFLAGS" + fi +fi +AC_SUBST([LIBS_TESTGUI]) +AC_SUBST([CFLAGS_TESTGUI]) +AC_SUBST([backend]) + +# OS info for Automake +AM_CONDITIONAL(OS_LINUX, test "x$os" = xlinux) +AM_CONDITIONAL(OS_DARWIN, test "x$os" = xdarwin) +AM_CONDITIONAL(OS_FREEBSD, test "x$os" = xfreebsd) +AM_CONDITIONAL(OS_KFREEBSD, test "x$os" = xkfreebsd) +AM_CONDITIONAL(OS_HAIKU, test "x$os" = xhaiku) +AM_CONDITIONAL(OS_WINDOWS, test "x$os" = xwindows) + +AC_CONFIG_HEADERS([config.h]) + +if test "x$os" = "xlinux"; then + AC_CONFIG_FILES([pc/hidapi-hidraw.pc]) + AC_CONFIG_FILES([pc/hidapi-libusb.pc]) +else + AC_CONFIG_FILES([pc/hidapi.pc]) +fi + +AC_SUBST(LTLDFLAGS) + +AC_CONFIG_FILES([Makefile \ + hidtest/Makefile \ + libusb/Makefile \ + linux/Makefile \ + mac/Makefile \ + testgui/Makefile \ + windows/Makefile]) +AC_OUTPUT diff --git a/c/src/third-party/hidapi/dist/hidapi.podspec b/c/src/third-party/hidapi/dist/hidapi.podspec new file mode 100644 index 000000000..f5449f978 --- /dev/null +++ b/c/src/third-party/hidapi/dist/hidapi.podspec @@ -0,0 +1,31 @@ +Pod::Spec.new do |spec| + + spec.name = "hidapi" + spec.version = "0.9.0" + spec.summary = "A Simple library for communicating with USB and Bluetooth HID devices on Linux, Mac and Windows." + + spec.description = <<-DESC + HIDAPI is a multi-platform library which allows an application to interface with USB and Bluetooth HID-Class devices on Windows, Linux, FreeBSD, and macOS. HIDAPI can be either built as a shared library (.so, .dll or .dylib) or can be embedded directly into a target application by adding a single source file (per platform) and a single header. + DESC + + spec.homepage = "https://github.com/libusb/hidapi" + + spec.license = { :type=> "GNU GPLv3 or BSD or HIDAPI original", :file => "LICENSE.txt" } + + spec.authors = { "Alan Ott" => "alan@signal11.us", + "Ludovic Rousseau" => "rousseau@debian.org", + "libusb/hidapi Team" => "https://github.com/libusb/hidapi/blob/master/AUTHORS.txt", + } + + spec.platform = :osx + spec.osx.deployment_target = "10.7" + + spec.source = { :git => "https://github.com/libusb/hidapi.git", :tag => "hidapi-#{spec.version}" } + + spec.source_files = "mac/hid.c", "hidapi/hidapi.h" + + spec.public_header_files = "hidapi/hidapi.h" + + spec.frameworks = "IOKit", "CoreFoundation" + +end diff --git a/c/src/third-party/hidapi/doxygen/Doxyfile b/c/src/third-party/hidapi/doxygen/Doxyfile new file mode 100644 index 000000000..b1ea0a223 --- /dev/null +++ b/c/src/third-party/hidapi/doxygen/Doxyfile @@ -0,0 +1,2482 @@ +# Doxyfile 1.8.15 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the configuration +# file that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# https://www.gnu.org/software/libiconv/ for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = hidapi + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all generated output in the proper direction. +# Possible values are: None, LTR, RTL and Context. +# The default value is: None. + +OUTPUT_TEXT_DIRECTION = None + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 8 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines (in the resulting output). You can put ^^ in the value part of an +# alias to insert a newline as if a physical newline was in the original file. +# When you need a literal { or } or , in the value part of an alias you have to +# escape them by means of a backslash (\), this can lead to conflicts with the +# commands \{ and \} for these it is advised to use the version @{ and @} or use +# a double escape (\\{ and \\}) + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = YES + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice +# sources only. Doxygen will then generate output that is more tailored for that +# language. For instance, namespaces will be presented as modules, types will be +# separated into more groups, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_SLICE = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, +# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: +# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser +# tries to guess whether the code is fixed or free formatted code, this is the +# default for Fortran type files), VHDL, tcl. For instance to make doxygen treat +# .inc files as Fortran files (default is PHP), and .f files as C (default is +# Fortran), use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See https://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = NO + +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 0. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 0 + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO, these declarations will be +# included in the documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES, upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong or incomplete +# parameter documentation, but not about the absence of documentation. If +# EXTRACT_ALL is set to YES then this flag will automatically be disabled. +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. +# The default value is: NO. + +WARN_AS_ERROR = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = ../hidapi + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: https://www.gnu.org/software/libiconv/) for the list of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, +# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, +# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, +# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice. + +FILE_PATTERNS = + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = NO + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# entity all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see https://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# https://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to YES can help to show when doxygen was last run and thus if the +# documentation is up to date. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = YES + +# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML +# documentation will contain a main index with vertical navigation menus that +# are dynamically created via Javascript. If disabled, the navigation index will +# consists of multiple levels of tabs that are statically embedded in every HTML +# page. Disable this option to support browsers that do not have Javascript, +# like the Qt help browser. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_MENUS = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: https://developer.apple.com/xcode/), introduced with OSX +# 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy +# genXcode/_index.html for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the master .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANSPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# https://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from https://www.mathjax.org before deployment. +# The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/ + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /