diff --git a/assets/navigation.js b/assets/navigation.js index d6171e4..9b30b70 100644 --- a/assets/navigation.js +++ b/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA42U207CQBCG32W9BbUIKtwZPNCI0AhJLwhpaju4G7bbph08xPjuZlt6Xrbebr/5pvNndjc/BOELyYS4B6SkRyIXKZmQIPQPHJILeXpOMeCkR/ZM+GQy6BGPMu7HIMhkU5RPOQOBdzWJx90kySUlUPcZg9vfXqFZQfwBsUZTAjrNbL22LIDYvJekFYcYlr4PN2buWzGdgq2rrwYVc0muPAoBnNQ2wZZzW7Ey4cNXO/30+H/xHxIMAznKzBU+h9gUDEshEwjxzvUKp5JvdBpdV/7wEdCj0zCIQgECE426Qeqksr/GJD93lXfMmSNdGpshPWaS5dHhbPG6BvbDfO48L5b2wrFel+vldDlfqfYm06tozUJSxKiU7Q7CQxaKcncw6hv18uthozwbJLtZelWVbEmrCx0x8d7eZ3n6r3W2zMVTMb1j3qvSSmVNUBNUAsK3ar9VTpi6ckCTViIn75AcCW08n8B5fy/CT9GnzX3Lw5KMkzIOVe6YOjr9snXIz05UZx2Hxnh4dVnNwwbOn6WldWvyR1vRqFmke8jT5zh5cSsrjt+R2luwjZwuxzfGSL632z8DYBsO7gYAAA==" \ No newline at end of file +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA5WVX2+bMBTFv4v3mqxNmnZr3qa0W1HTgJZIeagixOCmtmJsC27aTlO/e2UI/43JXs25v8s9Phee/xGEdyRzEhyRkhFRAVIyJ7GMjhzSC336lWLMyYgcmIjIfDoiIWU8SkCQ+XNZvuAMBP5oQEIepGkBqQRN3mT6/WNUYtaQvEJiwVQCG0Y/B4EsDBDyClchkyKtqEwgJPsgLMC9Ja3xr296+kQ/AUP6X30aJbY+D4jqIRARh6SfXBPZWJWDrrK8Z0Nm423kAYQj9rKfVUqsM242ngeQOHe6qZdIrBFfg4QFf8pEGrRN9NW0Rq6U65BCDL3YtrDD3NWoTETw3t2Y7Pi8lTmmKGM9yunWHMHQaGLONOptjmbpWshYSQECzXedo1vKoWuykPTjofKBOQvJEGbLkJ48saxGxezobQ2298ul/7hytyvf++1u3IW7XJtyk+NNaksgKaKqYPujCLMvQJkdVONJs/xm1irPB8mX1I6qKzvQeqAVEy/dPOvTs+LsOatf5fS+c2dyK4O1hRajUhCR13itasKMVQgsbqV68gHISWG15w04Hx+EfBNj2s5bYZbW+JnGp8aMma2zh20A/qWnOu84m9zOri7rfmyB80dN6WxN8aM1NGoX2X6+2ec4lLweAfyrzOBK3HLq8vbb5HraxqZPgTqXqrVm6O5j9wnKZG9r+QgAAA==" \ No newline at end of file diff --git a/assets/search.js b/assets/search.js index a1b3190..b0fbff0 100644 --- a/assets/search.js +++ b/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA7WbW2/buBKA/4vyqmTDm2znbTd79jTYtgm2wemDERiqzdhCbckryUmDIP/9gJQsDeUZhbLblyax58b5hkOKYl+DPHsugqvpa/A9SRfBFQ+DNN7o4CpI0oX+EYTBLl8HV8EmW+zWuvjNfnqxKjfrIAzm67godBFcBcFbuLcQycbEqiy3jYXHXTovkyxtbZTbc4aYCoNtnOu0bGIAtpUSUWN+NitfttrHwZn5/aKR73Fmtew/9JCud0WZbb7o/Ennvd6h4C8e6IGrs4NPvYffsdUZcBskV22IH+7v75oAk7TU+WM8b+rFfDssAfxSjhvjj7qcrzysn+0F+0ZoIyUcbXP9mPz4K8vv8qzM5tnaxymmdGwAS13eaZ1/0mXs49oVP9bpKk4Xa20khgwb1RoSQqd6viblqiq0D9Zy3h/EgfgJ9VWYyv6q1+u/0+w53Q+nOCaAM9rWe7k5TAARbq6XSVFqzyIl4kSMnBQgoPmXmYXX2WabpTote9LYERxGkF1y2UlJHvcUDebsDOr1Db87JCKMeZam2vbmT3EaL/tqGA0H0/8JYa2z5fBYGqXjAuhO75s0KfsL1Uj82kWi8eC9UNio8UHVM+H+/q6eDf0jRMVPGO68a+8Y12eYlb6c4IMGITbxxbtydbB7NB/2bh5b/W2SLg/0zYe+m0/biO+glXbfZO00Av0UbCCEh3TR76D6fpB90abg7ubzf2d3/9ze317ffpzd/Nn4eYrzJP7WJKQrN8hf6+5Zr9fn382qdb7qlNQ+/0ZkZkVmK3LVhQU7GTEFBmTWmuJT3D4UmB0parYR7R8MEjPogbydLs2K3J0ttV0shq7OCaEoxuEiUZT5bl5mx0dx5hrxjejAGLVibF7cLUxxfKSYqTbeslicJ8X5Nk+e4lIfHz2yof1H/7vTRXl85F0zPyPLfhu5waF67+aGRQua0df/fPw4+/vz7dfPTav5gjSkapnAhIetdbANap3f/Pn7rlx9ma/0RiNe7brSlet3aNcn1J99pGls2YxSLhHRQV5hh7peJzotf4fL5r4MrK/2+0EufDsP5sOry3QUqY7yXb/4+awET/JVZt91etiyUHeN7Oke7+8/DvBZSQ/12jktSHUel/p6Fa/XOl1qP/eYmk9H9oxKp/Nsoe2EiPN448kB0fqJMX3Tca5zI/FBxwtk+UdjQrRO4mXEdFom87jUnePD3jhQvcH1CnpNZYTuNe33v67XdHz49xoQ/NBe0/X5bq9539dTvE4WH7KitH97ee2qDPXfezjs7/m9A+GuBTfsoxphNx6/Rvg+hM4BR6/Pd841PD2aY3HqUQJ16yoM9e20keekXHnP3TMgfZJX2ISorTUaAK54Uiy5jgfOuY6G99LiE0u5y9N3luDDcLpKJ+VjqdM/7Fp1byaUXwgHOidFsEuf83g7OAhM7dRM3G7jf3eeHKD4Txj/ENcdjZO8F8ky/SP74ee4FT7J55POk8cXb69Q/FTCPptehPTxm140KskmUlxKvyfkd07Qzghl/6Omh7B+hr56NWiKJEuDq4BfiItJEAaPiV4vzHv+YN8As83GGHuov/ufNhsvI1GJ/HYZhNPLUIwvBHt4CKd7Bfu5/cBKsSCcslCICybGjhhzxHgQTnnIJxcjwR0x7oiJIJwKxKdwpCRlTDpiigpNOWJREE4lJhY5YqMgnCoktJEjNQ7CaYRIjR2pSRBOR4jUxE2tyfQYEWMdBCbVE0zOZcBMrtklCsvFwEy+GcNMuiSYyTjjmKDLglkYGFrm0mAm6wzlwVwgzGSeYUiYy4SNKcLMxcJM/hmGj7lkuAHAMILcRcPt9MAY8s78sGwwiNxFww0Ajs1L7qLhdpZgDLmLhhsAHGPIXTTc5J+LkLMLLlnIZfObqn9ztV1c3EDhWHK5i4sbKBxNrouLGyh8jHYVl5cwVDiWXeHyEoaKwLIrXF6Cnkui09JsT0P7kHCJCcNFYCCES0wYLgLtky4xYRAIiQm6cMSITKVw6QjDQCh0OC4eYRgIDLhw6UjDQIwwk9LFIy2eMSrp8pEGgsCISxePNAwkRlx2Fh3DQGLzSbp0pGEgMYzSpSMjMunSxSNHZNKli0faXoeVhnTpyAm5iLp0FE1HuXQUI1u3cukow0BidalcOsrSwXq8cukoSwcrNtXZFFg6WHdRLh1l9wVY61YuHGUISKzUlMtGGQIKKzXlslGGgMJKTblsIgNAYaUWuWgik3+FlUXkkolM/hVGJnLJRIKcipGLJpJkA4wqNnbn+qTzUi9uqh3sdNqcar0Gs3pb2xwtvgY8uHp9CwNZ/5iYn2/tntb8ZfxUVxBaC2wMTLAepf1pRb4/rWhtyKi1oaSHjaI+rwUmWGtCUiaqo2djaFUfPQMDl8CAIAzM7RlwNwVCtqoiolSbW0ib/S0kkETRWmCKttCe5QKEEMCkoidGNUUyGnvlxByfNbcSQDQjYPHS10Jib+oAKwAqo6qpekFhErqtX1CAtE4AEU4YqO8cAY6tUlQlgY37dOfgSh0IHpQTo6phqdOqosrqkAUEAUJXI1rdPjzP24dnMHhAVbJqIFFPIFl95NFaUGAIisr/UpdbrfONveva6gJ0VPIq6ob/tnk93hoAFUS5RgqPK1B4VOnWeoddRIAZLKhOVN2eB6AB5yrL1PQzmlXRH3YfMH0pRsRck6BeFVXkRvdgeoFcMarELB6t82Rhp1j11h2EDePuG7c57q4n/OEQQKUyqlvU/++hVQKsKB37HgkECwYsxnV/owZuz3Gc0pIepbV/iwGyDNRY3U8UVVubF3OGZF1v60s5IADQEgQ15JZVUd/KAOMHa7WgVrjqgh+IH3jlVHkZpdl+Fs+ShRM23CFQJVJd1n/McqwVAGwUrSpbm9iZmRw0IU5pmjcQq+YNBJhWoAEpKuz9/R4sagYKlNVbI0ElEFx4BhZA5hjFq3plga4AEswrRVWsuQ3ZZc5BT+OUY9vDDjTBoDnVyKru190DSTBaSSXcqrpzpLrG39oB9cqoeWbO2r9lTjtRoJNFlN7+VgqYU6DGBLVQWbWydMpDgPqSl3VfoGZ19VKC2CookHNFLbaVBWSNB1mPKPf2FTM6SUDSJOW6esXQTTfcZVGzwoB2qkt4tGBwlI/WhwDFLUS9L6KKvCk1bK8BN7nU4M26d1DpoKEpdJI8hME22ep1kurgavrw9vZ/gV8h7BE4AAA="; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA71cW3ObyBL+L/iVeM1cAPltN3v2JLVJ7Nq4Th5UKRcrjS0qEmgRTjblyn/fmgFB96gbg6Q9L7Ej9f37umeAwc9BVX7bBdfz5+BLXiyDaxEGRbYxwXWQF0vzdxAGT9U6uA425fJpbXY/uU8vV/VmHYTBYp3tdmYXXAfBj3BvIVadiVVdbzsLD0/Fos7LordRb19FhKkw2GaVKeouBmBbaxl35u/v6+9bM8bBhf39spMfcOa03D98Sq+fdnW5+Wiqr6Ya9A4F/+VED1xdHHw6On3PlpdwH6TQfYhv7u5uuwDzojbVQ7bo+GK/nVYAcaXSzviDqRerEdYv9oJDGbpIGUfbyjzkf/9WVrdVWZeLcj3GKaV0bACPpr41pnpv6myMayx+rNNVVizXxkpMSZvUmhKCx55Peb1qiPbGWa6GgzgQP4FfO8vsT2a9/r0ovxX7dHbHBHDB23qpNocFYMKtzGO+q81IkjJxEkZOChCg+ZvtwtflZlsWpqgHyugJTkMwuhLKK0mVDZCGcnYB9YbS91NiwliURWHcbH6fFdnjEIfJcCj9M4S1Lh+nx9IpHReA395vi7weJqqV+HcXic7D6IXCRU0n1XbC3d1t2w3DGZLiJ6S78O0d4/qCsjJUEzppEGIXX/ZUrw52j/bDwc1jr7/Ni8cDffvh2M2nG8S30Eq/b3J2OoFhFFwgjIdiOeyg+X6SfdmX4Pbth//e3/5xc3fz+ubd/dtfOz9fsyrP/uwK4stN8te7+2bW61df7Kr1auVRal9/K3LvRO5X7KoLCTtLIg0SatcakIrdkpJ2e9nhdIioXwhg9z7bjvRvRU9wH4m+X7stgd+urV0qBl/nhFB0JOAqtaurp0VdHh/FBTYyNqIDY9yStfmO91C74yOlTPXx1rvlq3z3alvlX7PaHB89saP+w/z1ZHb18ZH7Zs5R5XE7ycmhjt5OTosWTMNP/3n37v73DzefPnSz7iMxEZt1ihKettjCOWxM9fbXn5/q1cfFymwM4dUtbL7csEO3QJL+3DVVZ8tVlHNJiE7yCifU63VuivpnuG7vaeB89d9PcjF28lA+Rk0ZT5GbKF/M93E+G8GTfNXlF1McjizSXSd7use7u3cTfDbSU716tysKU2W1eb3K1mtTPJpx7im1MRN5ZFSmWJRL4xoiq7LNSBwIrTPG9KfJKlNZiTcmW5rKXkvbxh0X24D2Sfj5do+L5tQorJgp6nyR1Wb5G7qMG4yD1DspkmX585GxMJpnZBDM1rv3PLpKnd7kWQPWicYIv0703/9764TnY/w6AYKfuk74Pv114gWEX/b8NVvnyzflrnb/HxWDr3JaNINPHcbH8dKTBt8CTuKoBc6Ph1zgTgbIu482GAFx++xk//ZZDHf5SAaBFaa2BRo/3/J6NbrnL4D0SV7h8OIup8gAaMXTsPAunbKJveppnDWW+qkqXtiEHYbjK50xokdT/OJ2CXe2EccFdKBzxnieim9Vtp0cEqV23irdbLO/nkYiBsXPXpspgXgaZ4xllz8Wv5R/jwujFz5jBF9NlT98Hx0DFD8vM8ZcWBEMOf7Cio4KPPE43OHebN3tburRgzPJaky7SQHXQPYxzwiHLzz2GbYwdp90TEijdky8oSYtbtPgL1ITA1xRS9ZRZSP6DF0CTwwMWTg1NIbmTU9MoTnS+H/Q/NDhVJrjJM9Acy6kyTTHhs5HcyLA6TTnyga55DYNb4uHkg2rkzieK4vKZDaIu3wgfeznwtMZSLlPgXHf3A4a67iTPsXldmhseA63Lw4Iyh0EsV8Yb7b8EEBSx4PJn9VgvLx0UONQbfQl9gjn4+4kc+7RIRHi4tYPAMhMqrCKZkpe9ZkOPkt64WH3BaM8/qHs57B92nT9bJfBXV4WwXUgLuXlLAiDh9ysl/ZIbrAfR+VmY419br/7n7G3uaxEI/LTVRDOr0J1dTlL9efP4Xyv4b5wHzixKAjnUSj1ZSpmSCxCYiII5yIUyWWaREhMIDEZhHNJOZVITHHWFBLTXGwaicVBOFehmF2msxiJxUgsCcK5pmJLkFgahPOYEkuR2CwI5wklNsPltdVOKbnIw8HWe0YKYiQiW/HoioQMgxHZokcRaRPjEdm6R4KUxJBEDhMS4gijEtnqRyqU4lJJiSUxMJEFICKhiTA2UcpBHWF0IotCRMIYYYCEhSEikRQYIeFahcRSeM3iICLBFBgiYXEQZJsKDJFwPUOCKTBEwuIgSDAFhkhYHIQMhbiM01Co/S+6+QWrYsyEBUaQBRYYM2GREXSBMWjCIiPoAmPQpEVGzChuSQyatMhIssASgyYtMpIssPSGnGQ7UGLQpEVGClISgyYtMpIenRg0aYGQipTEGEkLhCT7SmKMZMrXE2MkLRAyJjPCGCkLhCRxVxgj5TBKKe8KY6QcRjPKu8IYKQuEInFX3lpkgVAk7gpjpCwQimwshTFSbkki0VQYI2WBUCSaCmOk3Owj0VQYI2WBUGRvKoyR5vtIY4x0xOKuMUbaAqFI3DXGSEtuG6AxRFqxBNHejkGzi47GEGkHUUomhCHSDiJymmsMkbY4aJJ0GkOkLQ6aJJ3GEMUWB02SLsYQxRYHTZIuxhDFFgdNki7GEMUWCE2SLsYYxRYITZIuxhjFFghNEiT2NnYWCE0uCDHGKE7YwRBjjGKHEYlmjDGKZ+y+EkOUXHE8TjBCiYUhJheOBCOUWBhikh8JRiixMMQkPxKMUKK4fBIMUKLZfDA+Sczn4+29LQgxyc0E45O4/TfJzQTjk1gUYnpHjwFKLQwxvanHCKUOIZKbKUYoFeykSTFCqWSnV4oRShU7k1IMUarZjUXaYOQuJ7+aqjbLt81l5Xze3a17Du7ba83udMVzIILr5x9hoJofWjY/k6v2p7Y/f/QXnvZ/1m9zpL+3GKXAZDSg1N19bW9M9iaU7E2oeLSJcn9DtrekZ72lOB1hqdo/FQY2rnobeoyNXXueBiSkQULjTRAJxQCwRDKW9nfTgBoIIJkNqtkwVu0JLpAB8Ks4KvgG7PP+5kYbMBQBQ4oxtHCnjXxmSZCETDjV7mWpzf5lKcBNQKyIywKdGgKdAqgk26aQadssV5yt9oZq7W6oAjwUwIMjRPMajj2t0b15AVJJQJux7n0LuXsbCViJQUE4XizLF9oVJKM4XJqDlNbQtj1ICQyADlMcqQ/dgtZuYIhaOOJZO7M4fjlbC/AuIqgI4GfExfJoiobrdfP4HwwLwLCYm377B7KL/oEsYDngmWpncsxV9dEUZfvAHcQA+iTmU6hta27cS8KAmL0qR8uGSpZU2+5Yf28A0JLjE8FmAUIW3MRv9Q4ntASYScFpd49yQLaAeEnUkoZ17/5uAWAKIEo7BgY0m1Y8XBoAXziomAmgwEKr2w5IOcZbGwfND4oecQxzOBtT5UvXu81rByB80IVyqHJ2LWjH0WEqIJOIm2XtX57olQB2nI47jAmCBeyW7YzQXJO62/OIo2oER/ePXUCVgVrUwqR1CxdH1s13+4jAhbBt304CaYDMJRe+v+7GsLO5evVA79p3WoBXyFSO6c37mSB5MMwEl6xVut/Pkvt8iYoON6isV/e3Fh7KihpIcOfD6jdqnmtQMTGouttkaDIIuDZzY9Qe/KNmkgZzRXMjdP9iFZVwBOgRtQuI5GYLeNUdWABFj7iJ0pwUJJcwDfRjjmv2PVifLgLkLjjHboYeaIKkBZdsM339baUCOCuu4L1qucUbcoB1yjWj08Yd3fz5h94OaJSINZM/Fn+WaAhq4D7m+sPtUnJ33gAEDvo54ei9fw0JjAHgUHHYOrW6RrSUYMir/YLZXmymHGLNmUJurwV3gNxwaSwQmySAesxRzZ1Bp5pUgSpoznVzFMkHDJQh5laRRvNghIPuSDinlmWoMeSIVQs81CbJKUFDyz1mHNs6nlP7PHhzgOs1u1U4aFLQH5pk6+cw2OZbs84LE1zPP//48Q+FqTVFxkoAAA=="; \ No newline at end of file diff --git a/classes/auth.ClientAuth.html b/classes/auth.ClientAuth.html index 2fb8484..9092676 100644 --- a/classes/auth.ClientAuth.html +++ b/classes/auth.ClientAuth.html @@ -1,9 +1,17 @@ -ClientAuth | @libp2p/http-fetch

Class ClientAuth

Constructors

constructor +ClientAuth | @libp2p/http-fetch

Class ClientAuth

Constructors

constructor

Properties

key tokenTTL tokens

Methods

authenticateServer +authenticatedFetch bearerAuthHeader +bearerAuthHeaderWithPeer +doAuthenticatedFetch encodeAuthParams generateChallenge -

Constructors

constructor

Properties

key

key: PrivateKey

tokenTTL

tokenTTL: number = ...

tokens

tokens: Map<string, tokenInfo> = ...

Methods

authenticateServer

bearerAuthHeader

  • bearerAuthHeader(hostname): undefined | string

  • Parameters

    • hostname: string

    Returns undefined | string

Private encodeAuthParams

Private generateChallenge

Settings

Member Visibility

Theme

On This Page

constructorkeytokenTTLtokensauthenticateServerbearerAuthHeaderencodeAuthParamsgenerateChallenge
\ No newline at end of file +

Constructors

constructor

Properties

key

key: PrivateKey

tokenTTL

tokenTTL: number = ...

tokens

tokens: Map<string, TokenInfo> = ...

Methods

authenticateServer

authenticatedFetch

  • authenticatedFetch(request, options?): Promise<Response & {
        peer: PeerId;
    }>

  • authenticatedFetch is like fetch, but it also handles HTTP Peer ID +authentication with the server.

    +

    If we have not seen the server before, verifyPeer will be called to check +if we want to make the request to the server with the given peer id. This +happens after we've authenticated the server.

    +

    Parameters

    Returns Promise<Response & {
        peer: PeerId;
    }>

bearerAuthHeader

  • bearerAuthHeader(hostname): undefined | string

  • Parameters

    • hostname: string

    Returns undefined | string

bearerAuthHeaderWithPeer

  • bearerAuthHeaderWithPeer(hostname): undefined | {
        authorization: string;
        peer: PeerId;
    }

  • Parameters

    • hostname: string

    Returns undefined | {
        authorization: string;
        peer: PeerId;
    }

Private doAuthenticatedFetch

Private encodeAuthParams

Private generateChallenge

Settings

Member Visibility

Theme

On This Page

constructorkeytokenTTLtokensauthenticateServerauthenticatedFetchbearerAuthHeaderbearerAuthHeaderWithPeerdoAuthenticatedFetchencodeAuthParamsgenerateChallenge
\ No newline at end of file diff --git a/classes/auth.ServerAuth.html b/classes/auth.ServerAuth.html index b118bdb..33a8024 100644 --- a/classes/auth.ServerAuth.html +++ b/classes/auth.ServerAuth.html @@ -1,18 +1,18 @@ -ServerAuth | @libp2p/http-fetch

Class ServerAuth

Constructors

constructor +ServerAuth | @libp2p/http-fetch

Class ServerAuth

Constructors

constructor

Properties

httpHandler -key -logger? -tokenTTL -validHostname -

Methods

authenticateRequest -genBearerToken -genOpaque +key +logger? +tokenTTL +validHostname +

Methods

authenticateRequest +genBearerToken +genOpaque generateChallenge readHostname -returnChallenge -signBox -unwrapBearerToken -unwrapOpaque -verifyBox +returnChallenge +signBox +unwrapBearerToken +unwrapOpaque +verifyBox withAuth -

Constructors

constructor

  • new ServerAuth(key, validHostnames, opts?): ServerAuth

  • Parameters

    • key: PrivateKey
    • validHostnames: ((hostname) => boolean)
        • (hostname): boolean

        • Parameters

          • hostname: string

          Returns boolean

    • Optional opts: {
          logger?: Logger;
          tokenTTL?: number;
      }
      • Optional logger?: Logger
      • Optional tokenTTL?: number

    Returns ServerAuth

Properties

httpHandler

httpHandler: httpHandler = ...

key

key: PrivateKey

Optional logger

logger?: Logger

tokenTTL

tokenTTL: number = ...

validHostname

validHostname: ((hostname) => boolean)

Type declaration

    • (hostname): boolean

    • Parameters

      • hostname: string

      Returns boolean

Methods

authenticateRequest

genBearerToken

  • genBearerToken(clientPeerId, hostname): string

  • Parameters

    • clientPeerId: PeerId
    • hostname: string

    Returns string

genOpaque

Private generateChallenge

Private readHostname

returnChallenge

signBox

unwrapBearerToken

unwrapOpaque

verifyBox

withAuth

Settings

Member Visibility

Theme

On This Page

constructorhttpHandlerkeyloggertokenTTLvalidHostnameauthenticateRequestgenBearerTokengenOpaquegenerateChallengereadHostnamereturnChallengesignBoxunwrapBearerTokenunwrapOpaqueverifyBoxwithAuth
\ No newline at end of file +

Constructors

constructor

Properties

httpHandler

httpHandler: HttpHandler = ...

Private Readonly key

key: PrivateKey

Private Optional Readonly logger

logger?: Logger

Private Readonly tokenTTL

tokenTTL: number = ...

Private Readonly validHostname

validHostname: ((hostname) => boolean)

Type declaration

    • (hostname): boolean

    • Parameters

      • hostname: string

      Returns boolean

Methods

Private authenticateRequest

Private genBearerToken

Private genOpaque

Private generateChallenge

Private readHostname

Private returnChallenge

Private signBox

Private unwrapBearerToken

Private unwrapOpaque

Private verifyBox

withAuth

Settings

Member Visibility

Theme

On This Page

constructorhttpHandlerkeyloggertokenTTLvalidHostnameauthenticateRequestgenBearerTokengenOpaquegenerateChallengereadHostnamereturnChallengesignBoxunwrapBearerTokenunwrapOpaqueverifyBoxwithAuth
\ No newline at end of file diff --git a/classes/well_known_handler.WellKnownHandler.html b/classes/well_known_handler.WellKnownHandler.html index 560f944..f3eb91c 100644 --- a/classes/well_known_handler.WellKnownHandler.html +++ b/classes/well_known_handler.WellKnownHandler.html @@ -1,5 +1,5 @@ -WellKnownHandler | @libp2p/http-fetch

Class WellKnownHandler

Constructors

constructor +WellKnownHandler | @libp2p/http-fetch

Class WellKnownHandler

Constructors

constructor

Properties

myWellKnownProtos

Methods

handleRequest registerProtocol -

Constructors

constructor

Properties

Private Readonly myWellKnownProtos

myWellKnownProtos: ProtosMap = {}

Methods

handleRequest

registerProtocol

  • registerProtocol(protocol, path): void

  • Parameters

    • protocol: string
    • path: string

    Returns void

Settings

Member Visibility

Theme

On This Page

constructormyWellKnownProtoshandleRequestregisterProtocol
\ No newline at end of file +

Constructors

constructor

Properties

Private Readonly myWellKnownProtos

myWellKnownProtos: ProtosMap = {}

Methods

handleRequest

registerProtocol

Settings

Member Visibility

Theme

On This Page

constructormyWellKnownProtoshandleRequestregisterProtocol
\ No newline at end of file diff --git a/functions/index.http-1.html b/functions/index.http-1.html index c642d7d..215b872 100644 --- a/functions/index.http-1.html +++ b/functions/index.http-1.html @@ -1,3 +1,3 @@ http | @libp2p/http-fetch

Function http

  • http(init?): ((components) => HTTP)

  • Create an HTTP service that provides a fetch implementation and a way to register custom HTTP handlers.

    Parameters

    • init: HTTPInit = {}

      Options to configure the HTTP service.

      -

    Returns ((components) => HTTP)

Settings

Member Visibility

Theme

\ No newline at end of file +

Returns ((components) => HTTP)

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/index.httpCustomServer.html b/functions/index.httpCustomServer.html index c46f221..9c86156 100644 --- a/functions/index.httpCustomServer.html +++ b/functions/index.httpCustomServer.html @@ -1,4 +1,4 @@ httpCustomServer | @libp2p/http-fetch

Function httpCustomServer

Settings

Member Visibility

Theme

\ No newline at end of file +

Returns ((components) => HTTP & HTTPWithCustomHandler)

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/ping.sendPing.html b/functions/ping.sendPing.html index 7f57db5..1a46dd0 100644 --- a/functions/ping.sendPing.html +++ b/functions/ping.sendPing.html @@ -1,4 +1,4 @@ sendPing | @libp2p/http-fetch

Function sendPing

Settings

Member Visibility

Theme

\ No newline at end of file +

Returns Promise<void>

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/ping.servePing.html b/functions/ping.servePing.html index 553b819..c89f37a 100644 --- a/functions/ping.servePing.html +++ b/functions/ping.servePing.html @@ -1,4 +1,4 @@ servePing | @libp2p/http-fetch

Function servePing

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/interfaces/auth.AuthenticateServerOptions.html b/interfaces/auth.AuthenticateServerOptions.html new file mode 100644 index 0000000..c6a2998 --- /dev/null +++ b/interfaces/auth.AuthenticateServerOptions.html @@ -0,0 +1,9 @@ +AuthenticateServerOptions | @libp2p/http-fetch

Interface AuthenticateServerOptions

interface AuthenticateServerOptions {
    fetch?: {
        (input, init?): Promise<Response>;
        (input, init?): Promise<Response>;
        (input, init?): Promise<Response>;
    };
    hostname?: string;
    signal?: AbortSignal;
}

Hierarchy

Properties

fetch? +hostname? +signal? +

Properties

Optional fetch

fetch?: {
    (input, init?): Promise<Response>;
    (input, init?): Promise<Response>;
    (input, init?): Promise<Response>;
}

The Fetch implementation to use

+

Type declaration

Default

globalThis.fetch
+
+

Optional hostname

hostname?: string

The hostname to use - by default this will be extracted from the .host +property of authEndpointURI

+

Optional signal

signal?: AbortSignal

Settings

Member Visibility

Theme

On This Page

fetchhostnamesignal
\ No newline at end of file diff --git a/interfaces/auth.AuthenticatedFetchOptions.html b/interfaces/auth.AuthenticatedFetchOptions.html new file mode 100644 index 0000000..eb9672f --- /dev/null +++ b/interfaces/auth.AuthenticatedFetchOptions.html @@ -0,0 +1,39 @@ +AuthenticatedFetchOptions | @libp2p/http-fetch

Interface AuthenticatedFetchOptions

interface AuthenticatedFetchOptions {
    body?: null | BodyInit;
    cache?: RequestCache;
    credentials?: RequestCredentials;
    fetch?: {
        (input, init?): Promise<Response>;
        (input, init?): Promise<Response>;
        (input, init?): Promise<Response>;
    };
    headers?: HeadersInit;
    hostname?: string;
    integrity?: string;
    keepalive?: boolean;
    method?: string;
    mode?: RequestMode;
    priority?: RequestPriority;
    redirect?: RequestRedirect;
    referrer?: string;
    referrerPolicy?: ReferrerPolicy;
    signal?: null | AbortSignal;
    window?: null;
    verifyPeer?(peerId, options): boolean | Promise<boolean>;
}

Hierarchy

  • RequestInit
    • AuthenticatedFetchOptions

Properties

body? +cache? +credentials? +fetch? +headers? +hostname? +integrity? +keepalive? +method? +mode? +priority? +redirect? +referrer? +referrerPolicy? +signal? +window? +

Methods

verifyPeer? +

Properties

Optional body

body?: null | BodyInit

A BodyInit object or null to set request's body.

+

Optional cache

cache?: RequestCache

A string indicating how the request will interact with the browser's cache to set request's cache.

+

Optional credentials

credentials?: RequestCredentials

A string indicating whether credentials will be sent with the request always, never, or only when sent to a same-origin URL. Sets request's credentials.

+

Optional fetch

fetch?: {
    (input, init?): Promise<Response>;
    (input, init?): Promise<Response>;
    (input, init?): Promise<Response>;
}

The Fetch implementation to use

+

Type declaration

Default

globalThis.fetch
+
+

Optional headers

headers?: HeadersInit

A Headers object, an object literal, or an array of two-item arrays to set request's headers.

+

Optional hostname

hostname?: string

The hostname to use - by default this will be extracted from the .host +property of authEndpointURI

+

Optional integrity

integrity?: string

A cryptographic hash of the resource to be fetched by request. Sets request's integrity.

+

Optional keepalive

keepalive?: boolean

A boolean to set request's keepalive.

+

Optional method

method?: string

A string to set request's method.

+

Optional mode

mode?: RequestMode

A string to indicate whether the request will use CORS, or will be restricted to same-origin URLs. Sets request's mode.

+

Optional priority

priority?: RequestPriority

Optional redirect

redirect?: RequestRedirect

A string indicating whether request follows redirects, results in an error upon encountering a redirect, or returns the redirect (in an opaque fashion). Sets request's redirect.

+

Optional referrer

referrer?: string

A string whose value is a same-origin URL, "about:client", or the empty string, to set request's referrer.

+

Optional referrerPolicy

referrerPolicy?: ReferrerPolicy

A referrer policy to set request's referrerPolicy.

+

Optional signal

signal?: null | AbortSignal

An AbortSignal to set request's signal.

+

Optional window

window?: null

Can only be null. Used to disassociate request from any Window.

+

Methods

Optional verifyPeer

  • verifyPeer(peerId, options): boolean | Promise<boolean>

  • A function to verify the peer ID of the server. This function +will be called after the server has authenticated itself. +If the function returns false, the request will be aborted.

    +

    Parameters

    Returns boolean | Promise<boolean>

Settings

Member Visibility

Theme

On This Page

bodycachecredentialsfetchheadershostnameintegritykeepalivemethodmodepriorityredirectreferrerreferrerPolicysignalwindowverifyPeer
\ No newline at end of file diff --git a/interfaces/auth.HttpHandler.html b/interfaces/auth.HttpHandler.html new file mode 100644 index 0000000..68171b3 --- /dev/null +++ b/interfaces/auth.HttpHandler.html @@ -0,0 +1 @@ +HttpHandler | @libp2p/http-fetch

Interface HttpHandler

interface HttpHandler ((req) => Promise<Response>)

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/interfaces/auth.ServerAuthOps.html b/interfaces/auth.ServerAuthOps.html new file mode 100644 index 0000000..9a3d3ef --- /dev/null +++ b/interfaces/auth.ServerAuthOps.html @@ -0,0 +1,3 @@ +ServerAuthOps | @libp2p/http-fetch

Interface ServerAuthOps

interface ServerAuthOps {
    logger?: Logger;
    tokenTTL?: number;
}

Properties

logger? +tokenTTL? +

Properties

Optional logger

logger?: Logger

Optional tokenTTL

tokenTTL?: number

Settings

Member Visibility

Theme

On This Page

loggertokenTTL
\ No newline at end of file diff --git a/interfaces/auth.TokenInfo.html b/interfaces/auth.TokenInfo.html new file mode 100644 index 0000000..67825e0 --- /dev/null +++ b/interfaces/auth.TokenInfo.html @@ -0,0 +1,4 @@ +TokenInfo | @libp2p/http-fetch

Interface TokenInfo

interface TokenInfo {
    bearer: string;
    creationTime: Date;
    peer: PeerId;
}

Properties

bearer +creationTime +peer +

Properties

bearer

bearer: string

creationTime

creationTime: Date

peer

peer: PeerId

Settings

Member Visibility

Theme

On This Page

bearercreationTimepeer
\ No newline at end of file diff --git a/interfaces/index.CustomHTTPHandlerInit.html b/interfaces/index.CustomHTTPHandlerInit.html index 63c5a4c..295ed09 100644 --- a/interfaces/index.CustomHTTPHandlerInit.html +++ b/interfaces/index.CustomHTTPHandlerInit.html @@ -1,2 +1,2 @@ -CustomHTTPHandlerInit | @libp2p/http-fetch

Interface CustomHTTPHandlerInit

interface CustomHTTPHandlerInit {
    customHTTPHandler(req): Promise<Response>;
}

Methods

customHTTPHandler -

Methods

customHTTPHandler

Settings

Member Visibility

Theme

On This Page

customHTTPHandler
\ No newline at end of file +CustomHTTPHandlerInit | @libp2p/http-fetch

Interface CustomHTTPHandlerInit

interface CustomHTTPHandlerInit {
    customHTTPHandler(req): Promise<Response>;
}

Methods

customHTTPHandler +

Methods

customHTTPHandler

Settings

Member Visibility

Theme

On This Page

customHTTPHandler
\ No newline at end of file diff --git a/interfaces/index.FetchComponents.html b/interfaces/index.FetchComponents.html index 402abc5..6c51ac4 100644 --- a/interfaces/index.FetchComponents.html +++ b/interfaces/index.FetchComponents.html @@ -1,4 +1,4 @@ -FetchComponents | @libp2p/http-fetch

Interface FetchComponents

interface FetchComponents {
    connectionManager: ConnectionManager;
    logger: ComponentLogger;
    registrar: Registrar;
}

Properties

connectionManager +FetchComponents | @libp2p/http-fetch

Interface FetchComponents

interface FetchComponents {
    connectionManager: ConnectionManager;
    logger: ComponentLogger;
    registrar: Registrar;
}

Properties

connectionManager logger registrar -

Properties

connectionManager

connectionManager: ConnectionManager

logger

logger: ComponentLogger

registrar

registrar: Registrar

Settings

Member Visibility

Theme

On This Page

connectionManagerloggerregistrar
\ No newline at end of file +

Properties

connectionManager

connectionManager: ConnectionManager

logger

logger: ComponentLogger

registrar

registrar: Registrar

Settings

Member Visibility

Theme

On This Page

connectionManagerloggerregistrar
\ No newline at end of file diff --git a/interfaces/index.HTTP.html b/interfaces/index.HTTP.html index 0121547..fe5bc10 100644 --- a/interfaces/index.HTTP.html +++ b/interfaces/index.HTTP.html @@ -1,6 +1,6 @@ HTTP | @libp2p/http-fetch

Interface HTTP

HTTP service interface.

-
interface HTTP {
    fetch(request, requestInit?): Promise<Response>;
    getPeerMeta(peer): Promise<ProtosMap>;
    handleHTTPProtocol(protocol, path, handler): void;
    prefixForProtocol(peer, protocol): Promise<string>;
}

Methods

fetch +
interface HTTP {
    fetch(request, requestInit?): Promise<Response>;
    getPeerMeta(peer): Promise<ProtosMap>;
    handleHTTPProtocol(protocol, path, handler): void;
    prefixForProtocol(peer, protocol): Promise<string>;
}

Methods

fetch getPeerMeta handleHTTPProtocol prefixForProtocol -

Methods

fetch

getPeerMeta

handleHTTPProtocol

prefixForProtocol

Settings

Member Visibility

Theme

On This Page

fetchgetPeerMetahandleHTTPProtocolprefixForProtocol
\ No newline at end of file +

Methods

fetch

getPeerMeta

handleHTTPProtocol

prefixForProtocol

Settings

Member Visibility

Theme

On This Page

fetchgetPeerMetahandleHTTPProtocolprefixForProtocol
\ No newline at end of file diff --git a/interfaces/index.HTTPInit.html b/interfaces/index.HTTPInit.html index f8bf03b..22f70c8 100644 --- a/interfaces/index.HTTPInit.html +++ b/interfaces/index.HTTPInit.html @@ -1,4 +1,4 @@ HTTPInit | @libp2p/http-fetch

Interface HTTPInit

Options to configure the HTTP service.

Only required if you want to specify a custom fetch implementation. Or provide one if your environment does not have a global fetch.

-
interface HTTPInit {
    fetch?(request): Promise<Response>;
}

Methods

fetch? -

Methods

Optional fetch

Settings

Member Visibility

Theme

On This Page

fetch
\ No newline at end of file +
interface HTTPInit {
    fetch?(request): Promise<Response>;
}

Methods

fetch? +

Methods

Optional fetch

Settings

Member Visibility

Theme

On This Page

fetch
\ No newline at end of file diff --git a/interfaces/index.HTTPWithCustomHandler.html b/interfaces/index.HTTPWithCustomHandler.html index cc89a82..6027d4d 100644 --- a/interfaces/index.HTTPWithCustomHandler.html +++ b/interfaces/index.HTTPWithCustomHandler.html @@ -1,3 +1,3 @@ -HTTPWithCustomHandler | @libp2p/http-fetch

Interface HTTPWithCustomHandler

interface HTTPWithCustomHandler {
    registerProtocol(protocol, path): void;
    serveWellKnownProtocols(req): Promise<Response>;
}

Methods

registerProtocol +HTTPWithCustomHandler | @libp2p/http-fetch

Interface HTTPWithCustomHandler

interface HTTPWithCustomHandler {
    registerProtocol(protocol, path): void;
    serveWellKnownProtocols(req): Promise<Response>;
}

Methods

registerProtocol serveWellKnownProtocols -

Methods

registerProtocol

  • registerProtocol(protocol, path): void

  • Parameters

    • protocol: string
    • path: string

    Returns void

serveWellKnownProtocols

Settings

Member Visibility

Theme

On This Page

registerProtocolserveWellKnownProtocols
\ No newline at end of file +

Methods

registerProtocol

  • registerProtocol(protocol, path): void

  • Parameters

    • protocol: string
    • path: string

    Returns void

serveWellKnownProtocols

Settings

Member Visibility

Theme

On This Page

registerProtocolserveWellKnownProtocols
\ No newline at end of file diff --git a/modules/auth.html b/modules/auth.html index 60513d9..92bb46d 100644 --- a/modules/auth.html +++ b/modules/auth.html @@ -1,5 +1,10 @@ -auth | @libp2p/http-fetch

Module auth

Index

Classes

ClientAuth +auth | @libp2p/http-fetch

Module auth

Index

Classes

ClientAuth ServerAuth +

Interfaces

AuthenticateServerOptions +AuthenticatedFetchOptions +HttpHandler +ServerAuthOps +TokenInfo

Variables

HTTPPeerIDAuthProto PeerIDAuthScheme

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/modules/index.html b/modules/index.html index 545d6ca..716e089 100644 --- a/modules/index.html +++ b/modules/index.html @@ -5,7 +5,7 @@

Example

See the examples/ for full examples of how to use the HTTP service.

import { createLibp2p } from 'libp2p'
import { http } from '@libp2p/http-fetch'

const node = await createLibp2p({
    // other options ...
    services: {
      http: http()
    }
})

await node.start()

// Make an http request to a libp2p peer
let resp = await node.services.http.fetch('multiaddr:/dns4/localhost/tcp/1234')
// Or a traditional HTTP request
resp = await node.services.http.fetch('multiaddr:/dns4/example.com/tcp/443/tls/http')
// And of course, you can use the fetch API as you normally would
resp = await node.services.http.fetch('https://example.com')

// This gives you the accessibility of the fetch API with the flexibility of using a p2p network.
-

Index

Interfaces

CustomHTTPHandlerInit +

Index

Interfaces

CustomHTTPHandlerInit FetchComponents HTTP HTTPInit diff --git a/modules/ping.html b/modules/ping.html index 3396555..30ebf41 100644 --- a/modules/ping.html +++ b/modules/ping.html @@ -1,4 +1,4 @@ -ping | @libp2p/http-fetch

Module ping

Index

Variables

PING_PROTOCOL_ID +ping | @libp2p/http-fetch

Module ping

Index

Variables

PING_PROTOCOL_ID

Functions

sendPing servePing

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/modules/well_known_handler.html b/modules/well_known_handler.html index 0cad716..bc24595 100644 --- a/modules/well_known_handler.html +++ b/modules/well_known_handler.html @@ -1,4 +1,5 @@ -well-known-handler | @libp2p/http-fetch

Module well-known-handler

References

WELL_KNOWN_PROTOCOLS +well-known-handler | @libp2p/http-fetch

Module well-known-handler

References

WELL_KNOWN_PROTOCOLS

Classes

WellKnownHandler -

Type Aliases

ProtosMap +

Type Aliases

ProtocolID +ProtosMap

References

WELL_KNOWN_PROTOCOLS

Re-exports WELL_KNOWN_PROTOCOLS

Settings

Member Visibility

Theme

On This Page

WELL_KNOWN_PROTOCOLS
\ No newline at end of file diff --git a/types/well_known_handler.ProtocolID.html b/types/well_known_handler.ProtocolID.html new file mode 100644 index 0000000..d16d609 --- /dev/null +++ b/types/well_known_handler.ProtocolID.html @@ -0,0 +1 @@ +ProtocolID | @libp2p/http-fetch

Type alias ProtocolID

ProtocolID: string

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/well_known_handler.ProtosMap.html b/types/well_known_handler.ProtosMap.html index 3739b7b..d102bc9 100644 --- a/types/well_known_handler.ProtosMap.html +++ b/types/well_known_handler.ProtosMap.html @@ -1 +1 @@ -ProtosMap | @libp2p/http-fetch

Type alias ProtosMap

ProtosMap: Record<ProtocolID, {
    path: string;
}>

Type declaration

  • path: string

Settings

Member Visibility

Theme

\ No newline at end of file +ProtosMap | @libp2p/http-fetch

Type alias ProtosMap

ProtosMap: Record<ProtocolID, {
    path: string;
}>

Type declaration

  • path: string

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/variables/auth.HTTPPeerIDAuthProto.html b/variables/auth.HTTPPeerIDAuthProto.html index 4aabdbb..08a96d4 100644 --- a/variables/auth.HTTPPeerIDAuthProto.html +++ b/variables/auth.HTTPPeerIDAuthProto.html @@ -1 +1 @@ -HTTPPeerIDAuthProto | @libp2p/http-fetch

Variable HTTPPeerIDAuthProtoConst

HTTPPeerIDAuthProto: "/http-peer-id-auth/1.0.0" = '/http-peer-id-auth/1.0.0'

Settings

Member Visibility

Theme

\ No newline at end of file +HTTPPeerIDAuthProto | @libp2p/http-fetch

Variable HTTPPeerIDAuthProtoConst

HTTPPeerIDAuthProto: "/http-peer-id-auth/1.0.0" = '/http-peer-id-auth/1.0.0'

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/variables/auth.PeerIDAuthScheme.html b/variables/auth.PeerIDAuthScheme.html index 82d025c..ffe3561 100644 --- a/variables/auth.PeerIDAuthScheme.html +++ b/variables/auth.PeerIDAuthScheme.html @@ -1 +1 @@ -PeerIDAuthScheme | @libp2p/http-fetch

Variable PeerIDAuthSchemeConst

PeerIDAuthScheme: "libp2p-PeerID" = 'libp2p-PeerID'

Settings

Member Visibility

Theme

\ No newline at end of file +PeerIDAuthScheme | @libp2p/http-fetch

Variable PeerIDAuthSchemeConst

PeerIDAuthScheme: "libp2p-PeerID" = 'libp2p-PeerID'

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/variables/index.WELL_KNOWN_PROTOCOLS.html b/variables/index.WELL_KNOWN_PROTOCOLS.html index eb9f5dd..94b674e 100644 --- a/variables/index.WELL_KNOWN_PROTOCOLS.html +++ b/variables/index.WELL_KNOWN_PROTOCOLS.html @@ -1 +1 @@ -WELL_KNOWN_PROTOCOLS | @libp2p/http-fetch

Variable WELL_KNOWN_PROTOCOLSConst

WELL_KNOWN_PROTOCOLS: "/.well-known/libp2p/protocols" = '/.well-known/libp2p/protocols'

Settings

Member Visibility

Theme

\ No newline at end of file +WELL_KNOWN_PROTOCOLS | @libp2p/http-fetch

Variable WELL_KNOWN_PROTOCOLSConst

WELL_KNOWN_PROTOCOLS: "/.well-known/libp2p/protocols" = '/.well-known/libp2p/protocols'

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/variables/ping.PING_PROTOCOL_ID.html b/variables/ping.PING_PROTOCOL_ID.html index 91929b4..0f4c29c 100644 --- a/variables/ping.PING_PROTOCOL_ID.html +++ b/variables/ping.PING_PROTOCOL_ID.html @@ -1 +1 @@ -PING_PROTOCOL_ID | @libp2p/http-fetch

Variable PING_PROTOCOL_IDConst

PING_PROTOCOL_ID: "/http-ping/1" = '/http-ping/1'

Settings

Member Visibility

Theme

\ No newline at end of file +PING_PROTOCOL_ID | @libp2p/http-fetch

Variable PING_PROTOCOL_IDConst

PING_PROTOCOL_ID: "/http-ping/1" = '/http-ping/1'

Settings

Member Visibility

Theme

\ No newline at end of file