\n\nDocumentation: [jsr.io](https://jsr.io/@hpke/hybridkem-x-wing/doc) |\n[pages (only for the latest ver.)](https://dajiaji.github.io/hpke-js/hybridkem-x-wing/docs/)\n\n
\n\nAn example of use:\n\n```ts\nimport { Aes256Gcm, CipherSuite, HkdfSha256 } from \"@hpke/core\";\nimport { XWing } from \"@hpke/hybridkem-x-wing\";\n\nasync function doHpke() {\n const suite = new CipherSuite({\n kem: new XWing(),\n kdf: new HkdfSha256(),\n aead: new Aes256Gcm(),\n });\n\n // NOTE: The following support for JWKs with the AKP key type is experimental.\n // Please be aware that the specifications are subject to change without notice.\n const jwkPub = {\n kty: \"AKP\",\n kid: \"01\",\n alg: \"X-Wing\",\n pub:\n \"4iNrNajCSzmxCqEyOpapGaLO2IQAYzp7BxMXE_wUsrWxnPw9pfoaksSfJVE-D9MNaxYRyauWNdcIZyekt9IdNCROZpac8Vs7KnhTKfYbCWsnfqA3ODR5prVW3nIx_kt_qcmsJMBpmgAYpSU0AbrPqQXKgWVz5WotLgZ-m3KHUzuhOpN97bMfpEus7UB2mSNhADSuMeYZoXAkUZmzxcOYZIWf4bTJcXoHwwSVvfuYoKACzPVsEobO9QQd7ePETPFr9WLHRIUYAms9i5lAaAq9OKFXX9J7WNoGO_rDLDnDCGk3TAXBrrGJi2swPMaL5FU0buCvaZY2IkoUjKKuoQRjERxwn2m2nHDOhTh0ZpjExgqa7wAwx5JM7sQqXTaBb1RerhMpNGCzrLN-oOE9cOSqeGhto5ioOXwI6vloghE_5Pe61NpAsFAeHHU-_nMFPIcBToZhwzCZr-i-3kFKWxqifYOSs-Ex6acMEFWHgkDK0PQNX-PN-FI26tl-KpdEg2OygIyq_VFs0lBSxcNiVDwlF-Ss0OYOwHFjAJtkJfwyJ3rO5xwkurU-2fKedMZqCjVklVmY12uWqai1DRY1pNemfrQt9WRNMwRXKTqAQvU8x6aSiPF-1Vgn6Cso6CZlqGoU-9lmReyoFywET4O8DYwLTIYmmFYxyoevgpBo8TWJY8szNmTKSCdjujs7sghXf5umrGLCX3ZZJ0O2S-UZMXcUy0ECy3svmiWytPBhXeMd7NnKVQJtbaC2URGxb-Uv7tikh-FERiptupNyj1ALb_xJ5RVWnvJf7Rev9SBQc2glNSWGD1i-O-YclkYEpqyBTmk1WWQCpSCkZws9KEMYhmWT0VpLsBw14-WH7gxn0ogNbyQH-3pwcSuDjeuWxde_K0S89gOMy-M_vPUaVKWE_pAIPJHHptQ9T7FfSMYML9ZuCoqtStZOXEK7iHfA6-wrXjh8ipiP3CO-ueFsh1d4HgoUmcYeE4wh8hbCnQdpeYccqmlCuvwJBUS-6ZtUsWy5qaNk1iRtn0LM5TxmtZxFyPmukpmnXRUYDDyVIVGpG3oQdyQp3Ey65vzGIvqAGMY0OfiQYwuZKNtrt_lDiuQGXtNNc9SG8_UvkPCAfciN_djHKOlU8aw1wGwADOQaBYJYDju1e2cpcokKxeeYjnhQZXEW8bV9CAmq7ewL7eGuFIFIMRxvfjFzRuUYn7jNY1uYb4wL3SdkHFhLd4s6kRqAvhyWkquOG7sSg5VzzOGd8YO0WDW7tVBS-fxmoWeO8qNt6nhBHmyNYFAbTmBZLRNpipQ7UJGF25EuLqEL4GFxI2syfHFxYJTJZKaLAzd_UToFvNmcHzRlg7sFKXehChKt_HWANOVhfaTBJ2WF5XdOHzuZeLCdDpxE07yGFRxDqtGFcScXNAIjrDgdIRUKBClOl7sTu9ohtaGCttqWnhmn_QcnN_qOiApTwkKOPQSbfSGXQFKW3bNhkSp7z0gnztYR0Men2hBN3kMiCVM59kph1bsQj_C_TXgMrlCfsiwlaRQZP_c0kEJYEjfVIoKIJO4739B_sD8flC0uoXn-ci8GzAPeW2mFntsG7_OJsn3OWYRFcCFiI1k9S6MtmrrIzQSQQO9lNA\",\n key_ops: [],\n };\n const pk = await suite.kem.importKey(\"jwk\", jwkPub, true);\n // In addition to importing keys from external sources, you can also generate keys as follows:\n // const rkp = await suite.kem.generateKeyPair();\n // const rkp = await suite.kem.deriveKeyPair(random32bytesValue);\n\n const sender = await suite.createSenderContext({ recipientPublicKey: pk });\n\n const jwkPriv = {\n kty: \"AKP\",\n kid: \"01\",\n alg: \"X-Wing\",\n priv: \"f5wrpOiPgn1hYEVQdgWFPtc7gJP277yI6xpurPpm7yY\",\n key_ops: [\"deriveBits\"],\n };\n const sk = await suite.kem.importKey(\"jwk\", jwkPriv, false);\n const recipient = await suite.createRecipientContext({\n recipientKey: sk,\n enc: sender.enc,\n });\n const encrypted = await sender.seal(\n new TextEncoder().encode(\"Hellow world!\"),\n );\n const pt = await recipient.open(encrypted);\n\n // Hello world!\n console.log(new TextDecoder().decode(pt));\n}\n\ntry {\n doHpke();\n} catch (err: unknown) {\n console.log(\"failed:\", (err as Error).message);\n}\n```\n\n## Index\n\n- [Installation](#installation)\n - [Node.js](#nodejs)\n - [Deno](#deno)\n - [Web Browsers](#web-browsers)\n- [Usage](#usage)\n- [Contributing](#contributing)\n\n## Installation\n\n`@hpke/hybridkem-x-wing` needs to be used with\n[@hpke/core](https://github.com/dajiaji/hpke-js/blob/main/packages/core/README.md),\nwhich can be installed in the same manner as desribed below.\n\n### Node.js\n\nYou can install the package with npm, yarn or pnpm.\n\n```sh\n# Using npm:\nnpm install @hpke/hybridkem-x-wing\nyarn add @hpke/hybridkem-x-wing\npnpm install @hpke/hybridkem-x-wing\n# Using jsr:\nnpx jsr add @hpke/hybridkem-x-wing\nyarn add jsr:@hpke/hybridkem-x-wing\npnpm add jsr:@hpke/hybridkem-x-wing\n```\n\nThe above manner can be used with other JavaScript runtimes that support npm,\nsuch as Cloudflare Workers and Bun.\n\nThen, you can use the module from code like this:\n\n```ts\nimport { Aes256Gcm, CipherSuite, HkdfSha256 } from \"@hpke/core\";\nimport { XWing } from \"@hpke/hybridkem-x-wing\";\n```\n\n### Deno\n\nFor Deno, it is recommended to use the jsr.io registry.\n\n```sh\ndeno add jsr:@hpke/hybridkem-x-wing\n```\n\n### Web Browsers\n\nFollowings are how to use this module with typical CDNs. Other CDNs can be used\nas well.\n\nUsing esm.sh:\n\n```html\n\n\n\n\n\n```\n\nUsing unpkg:\n\n```html\n\n\n```\n\n## Usage\n\nThis section shows some typical usage examples.\n\n### Node.js\n\n```js\nimport { Aes256Gcm, CipherSuite, HkdfSha256 } from \"@hpke/core\";\nimport { XWing } from \"@hpke/hybridkem-x-wing\";\n\nasync function doHpke() {\n // setup\n const suite = new CipherSuite({\n kem: new XWing(),\n kdf: new HkdfSha256(),\n aead: new Aes256Gcm(),\n });\n\n const rkp = await suite.kem.generateKeyPair();\n\n // Note that the `ct` (ciphertext) resulting from X-Wing Encapsulate() is set to `sender.enc`.\n const sender = await suite.createSenderContext({\n recipientPublicKey: rkp.publicKey,\n });\n\n // encrypt\n const encrypted = await sender.seal(new TextEncoder().encode(\"Hello world!\"));\n\n const recipient = await suite.createRecipientContext({\n recipientKey: rkp.privateKey,\n enc: sender.enc, // == `ct` (ciphertext) in the context of X-Wing\n });\n\n // decrypt\n const pt = await recipient.open(encrypted);\n\n // Hello world!\n console.log(new TextDecoder().decode(pt));\n}\n\ntry {\n doHpke();\n} catch (err) {\n console.log(\"failed:\", err.message);\n}\n```\n\n### Deno\n\n```ts\nimport { Aes256Gcm, CipherSuite, HkdfSha256 } from \"@hpke/core\";\nimport { XWing } from \"@hpke/hybridkem-x-wing\";\n\nasync function doHpke() {\n // setup\n const suite = new CipherSuite({\n kem: new XWing(),\n kdf: new HkdfSha256(),\n aead: new Aes256Gcm(),\n });\n\n const rkp = await suite.kem.generateKeyPair();\n\n // Note that the `ct` (ciphertext) resulting from X-Wing::Encapsulate() is set to `sender.enc`.\n const sender = await suite.createSenderContext({\n recipientPublicKey: rkp.publicKey,\n });\n\n // encrypt\n const encrypted = await sender.seal(new TextEncoder().encode(\"Hello world!\"));\n\n const recipient = await suite.createRecipientContext({\n recipientKey: rkp.privateKey,\n enc: sender.enc, // == `ct` (ciphertext) in the context of X-Wing\n });\n\n // decrypt\n const pt = await recipient.open(encrypted);\n\n // Hello world!\n console.log(new TextDecoder().decode(pt));\n}\n\ntry {\n doHpke();\n} catch (_err: unknown) {\n console.log(\"failed.\");\n}\n```\n\n### Web Browsers\n\n```html\n\n \n \n \n \n \n\n```\n\n## Contributing\n\nWe welcome all kind of contributions, filing issues, suggesting new features or\nsending PRs.\n","readmeFilename":"README.md"}
![\"npm\"/](\"https://img.shields.io/npm/v/@hpke/hybridkem-x-wing\")
\n