Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/arx-research/libhalo
LibHaLo - Programmatically interact with HaLo tags from the web browser, mobile application or the desktop.
https://github.com/arx-research/libhalo
bitcoin ethereum hacktoberfest libhalo
Last synced: 1 day ago
JSON representation
LibHaLo - Programmatically interact with HaLo tags from the web browser, mobile application or the desktop.
- Host: GitHub
- URL: https://github.com/arx-research/libhalo
- Owner: arx-research
- License: mit
- Created: 2023-02-27T21:28:03.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-12-31T01:42:49.000Z (22 days ago)
- Last Synced: 2025-01-18T07:38:46.335Z (3 days ago)
- Topics: bitcoin, ethereum, hacktoberfest, libhalo
- Language: TypeScript
- Homepage: https://arx.org/?source=gh
- Size: 1.66 MB
- Stars: 51
- Watchers: 5
- Forks: 7
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# LibHaLo
[](https://github.com/arx-research/libhalo/actions/workflows/prod_build_cli.yml)
[](https://github.com/arx-research/libhalo/actions/workflows/prod_build_lib.yml)
Programmatically interact with [HaLo tags](https://arx.org/?source=gh) from the web browser, mobile application or the desktop.
## Installation
**Using NPM:**
```
npm install --save @arx-research/libhalo
```
**Using Yarn:**
```
yarn add @arx-research/libhalo
```
## Available APIs
The library exposes the following API functions:
### (Web browser) execHaloCmdWeb
```
async function execHaloCmdWeb(command, options)
```
For web browser applications: scan the HaLo tag presented to the smartphone, execute the
HaLo command and return the result. Supporting Chrome (Android), Safari (iOS) and other browsers.
Installation of additional software is not required on the user's side.
**Guides:**
* [Using libhalo as a standalone library in a classic HTML web application](https://github.com/arx-research/libhalo/blob/master/docs/web-standalone.md)
* [Using libhalo within a React.js web application](https://github.com/arx-research/libhalo/blob/master/docs/web-reactjs.md)
* [Documentation of the execHaloCmdWeb API](https://github.com/arx-research/libhalo/blob/master/docs/api-web.md)
* [Documentation of the utility functions exposed by LibHaLo](https://github.com/arx-research/libhalo/blob/master/docs/api-utils.md)
* [Interactive examples of using LibHaLo on web](https://halo-demos.arx.org/examples/)
### (React Native/Expo) execHaloCmdRN
```
async function execHaloCmdRN(nfcManager, command, options)
```
For React Native/Expo mobile applications (Android/iOS) based on `react-native-nfc-manager` library: scan the HaLo tag presented to the smartphone, execute the HaLo command and return the result.
**Guides:**
* [Using libhalo within a React Native application for Android/iOS](https://github.com/arx-research/libhalo/blob/master/docs/mobile-react-native.md)
* [Using libhalo within an Expo mobile application for Android/iOS](https://github.com/arx-research/libhalo/blob/master/docs/mobile-expo.md)
* [Documentation of the execHaloCmdRN API](https://github.com/arx-research/libhalo/blob/master/docs/api-react-native.md)
* [Documentation of the utility functions exposed by LibHaLo](https://github.com/arx-research/libhalo/blob/master/docs/api-utils.md)
* [Interactive examples of using LibHaLo on web](https://halo-demos.arx.org/examples/)
### (Desktop) execHaloCmdPCSC
```
async function execHaloCmdPCSC(command, reader)
```
For desktop applications based on `nfc-pcsc` library: scan the HaLo tag present at the specified `reader`, execute the HaLo command and return the result.
**Guides:**
* [Using libhalo as a CLI tool on the desktop computer with PC/SC reader (USB NFC reader)](https://github.com/arx-research/libhalo/blob/master/docs/desktop-cli.md)
* [Using libhalo to build your own application for desktop computers with PC/SC reader (USB NFC reader)](https://github.com/arx-research/libhalo/blob/master/docs/desktop-pcsc.md)
* [Using LibHaLo to build your own application for desktop computers using HaLo Gateway (using remote smartphone as the NFC reader)](https://github.com/arx-research/libhalo/blob/master/docs/desktop-gateway.md)
* [Documentation of the execHaloCmdPCSC API](https://github.com/arx-research/libhalo/blob/master/docs/api-pcsc.md)
* [Documentation of the utility functions exposed by LibHaLo](https://github.com/arx-research/libhalo/blob/master/docs/api-utils.md)
## Supported HaLo commands
This library supports the following HaLo tag commands:
* `sign` - sign arbitrary data using ECDSA private key on the NFC tag;
* `sign_random` - sign a sequential counter with random pad using ECDSA private key on the NFC tag;
* `sign_challenge` - sign a specified challenge using selected key slot on the NFC tag;
* `write_latch` - write one-time programmable memory slot on the NFC tag;
* `cfg_ndef` - configure the parameters returned in the dynamic URL when the NFC tag is scanned;
* `gen_key` - request generation of the key;
* `gen_key_confirm` - confirm the generated public key;
* `gen_key_finalize` - finish the key generation process;
* `get_pkeys` - get tag's public keys #1, #2 and #3;
* `get_key_info` - get information about the specified key slot;
* `version` - check HaLo tag's firmware version (only for PCSC/React Native);
* `read_ndef` - read the dynamic URL generated by the tag (only for PCSC/React Native);
Full articles:
* [Documentation of the available commands (HaLo Command Set)](https://github.com/arx-research/libhalo/blob/master/docs/halo-command-set.md)
* [HaLo Firmware Versions - command compatibility table](https://github.com/arx-research/libhalo/blob/master/docs/firmware-versions.md)
* [HaLo Key Slots - description of the available key slots and their functions](https://github.com/arx-research/libhalo/blob/master/docs/key-slots.md)
## Additional tools
This project also features additional tools which could increase interoperability.
### HaLo Bridge
The Bridge could be used to locally interconnect the USB NFC reader directly with a web application. This allows to execute multiple HaLo commands against multiple tags very quickly.
Guides:
* [Using HaLo Bridge](https://github.com/arx-research/libhalo/blob/master/docs/halo-bridge.md)
### HaLo Gateway
The Gateway could allow to use a compatible web application on the desktop computer, but with your own smartphone instead of the card reader.
Guides:
* [Using HaLo Gateway](https://github.com/arx-research/libhalo/blob/master/docs/halo-gateway.md)