{"id":22253557,"url":"https://github.com/nitrokey/nitrokey-websmartcard-js","last_synced_at":"2025-03-25T12:25:25.714Z","repository":{"id":57033762,"uuid":"526879714","full_name":"Nitrokey/nitrokey-websmartcard-js","owner":"Nitrokey","description":"TypeScript implementation of the Nitrokey Webcrypt client, along with a Vue demo application","archived":false,"fork":false,"pushed_at":"2023-07-31T13:45:19.000Z","size":454,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-25T06:49:48.400Z","etag":null,"topics":["nitrokey","nitrokey-webcrypt","nitrokey-websmartcard"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Nitrokey.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE-APACHE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-08-20T09:20:35.000Z","updated_at":"2023-07-31T11:04:01.000Z","dependencies_parsed_at":"2023-01-20T16:01:20.487Z","dependency_job_id":null,"html_url":"https://github.com/Nitrokey/nitrokey-websmartcard-js","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nitrokey%2Fnitrokey-websmartcard-js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nitrokey%2Fnitrokey-websmartcard-js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nitrokey%2Fnitrokey-websmartcard-js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nitrokey%2Fnitrokey-websmartcard-js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Nitrokey","download_url":"https://codeload.github.com/Nitrokey/nitrokey-websmartcard-js/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245460315,"owners_count":20619046,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["nitrokey","nitrokey-webcrypt","nitrokey-websmartcard"],"created_at":"2024-12-03T07:18:54.442Z","updated_at":"2025-03-25T12:25:25.682Z","avatar_url":"https://github.com/Nitrokey.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Nitrokey Webcrypt Demo Application\n\nThis repository contains TypeScript implementation of the Nitrokey Webcrypt client, \nalong with a Vue demo application using it, available at:\n- https://webcrypt.nitrokey.com/\n\nSee following for more information:\n- https://github.com/Nitrokey/nitrokey-webcrypt\n- https://github.com/Nitrokey/nitrokey-webcrypt-tests\n- https://github.com/Nitrokey/nitrokey-webcrypt-usbip\n\n![Main screen image](screen.png)\n\n### Implemented Operations in the Demo Application\n- session management (Login and Logout)\n- key generation (random);\n- key generation from seed;\n- data signing using generated key (`Sign` tab);\n- custom calls for all commands from the API (`Custom` tab);\n- automatic test execution of the all commands from the API (`TEST` button).\n\n### Usage\n1. Press `RESET AND LOGIN` button to reset the device's state by calling a factory reset operation, set new PIN and establish a session.\n2. Generate key - either randomly or from a key seed, with `GENERATE KEY` or `GENERATE KEY FROM SEED` respectively.\n3. Sign data hash by pressing `SIGN DATA` button.\n4. End session by pressing `LOGOUT`\n\nNote: all data are presented hexadecimal. \n\n### Custom Calls\nUsing `Custom` tab it is possible to send to device any API command.\nDefault PIN set by `RESET AND LOGIN` is `123123`, however one can run `FACTORY_RESET` command through the `Custom` tab, and set own and login with\n`SET_PIN` and `LOGIN` commands respectively.\n\nFor the fields marked as `:bytes` please enter data in hexadecimal format, and regular text for fields marked as `:string`.\n\n### Tests\nThe `TEST` button calls all API commands to check for the correctness of its implementation. \nThese tests are not exhaustive (that is realized by the Python test suite), but mostly test \"happy paths\". \n\n\n### Nitrokey Webcrypt API Documentation\n\nSee [Use Cases](./docs/use-cases.md).\n\n## Project setup\n```\nyarn install\n```\n\n### Compiles and hot-reloads for development\n```\nyarn serve\nyarn run vue-cli-service serve --https --open --host $(HOST) # for https\n```\n\n### Compiles and minifies for production\n```\nyarn build\n```\n\n### Lints and fixes files\n```\nyarn lint\n```\n\n### Customize configuration\nSee [Configuration Reference](https://cli.vuejs.org/config/).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnitrokey%2Fnitrokey-websmartcard-js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnitrokey%2Fnitrokey-websmartcard-js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnitrokey%2Fnitrokey-websmartcard-js/lists"}