Feat/add iana ipfs #95
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,182 @@ | ||
| 'use strict' | ||
|
There was a problem hiding this comment. this file shouldn't be committed here. might have been extra from a manual |
||
|
|
||
| const multihash = require('multihashes') | ||
| const multibase = require('multibase') | ||
| const Multiaddr = require('multiaddr') | ||
| const mafmt = require('mafmt') | ||
| const CID = require('cids') | ||
| const { URL } = require('iso-url') | ||
| const uint8ArrayToString = require('uint8arrays/to-string') | ||
|
|
||
| const pathGatewayPattern = /^https?:\/\/[^/]+\/(ip[fn]s)\/([^/?#]+)/ | ||
| const pathPattern = /^\/(ip[fn]s)\/([^/?#]+)/ | ||
| const defaultProtocolMatch = 1 | ||
| const defaultHashMath = 2 | ||
|
|
||
| // CID, libp2p-key or DNSLink | ||
| const subdomainGatewayPattern = /^https?:\/\/([^/]+)\.(ip[fn]s)\.[^/?]+/ | ||
| const subdomainIdMatch = 1 | ||
| const subdomainProtocolMatch = 2 | ||
|
|
||
| // Fully qualified domain name (FQDN) that has an explicit .tld suffix | ||
| const fqdnWithTld = /^(([a-z0-9]|[a-z0-9][a-z0-9-]*[a-z0-9])\.)+([a-z0-9]|[a-z0-9][a-z0-9-]*[a-z0-9])$/ | ||
|
|
||
| function isMultihash (hash) { | ||
| const formatted = convertToString(hash) | ||
| try { | ||
| multihash.decode(multibase.decode('z' + formatted)) | ||
| return true | ||
| } catch (e) { | ||
| return false | ||
| } | ||
| } | ||
|
|
||
| function isMultibase (hash) { | ||
| try { | ||
| return multibase.isEncoded(hash) | ||
| } catch (e) { | ||
| return false | ||
| } | ||
| } | ||
|
|
||
| function isCID (hash) { | ||
| try { | ||
| new CID(hash) // eslint-disable-line no-new | ||
| return true | ||
| } catch (e) { | ||
| return false | ||
| } | ||
| } | ||
|
|
||
| function isMultiaddr (input) { | ||
| if (!input) return false | ||
| if (Multiaddr.isMultiaddr(input)) return true | ||
| try { | ||
| new Multiaddr(input) // eslint-disable-line no-new | ||
| return true | ||
| } catch (e) { | ||
| return false | ||
| } | ||
| } | ||
|
|
||
| function isPeerMultiaddr (input) { | ||
| return isMultiaddr(input) && mafmt.IPFS.matches(input) | ||
| } | ||
|
|
||
| function isIpfs (input, pattern, protocolMatch = defaultProtocolMatch, hashMatch = defaultHashMath) { | ||
| const formatted = convertToString(input) | ||
| if (!formatted) { | ||
| return false | ||
| } | ||
|
|
||
| const match = formatted.match(pattern) | ||
| if (!match) { | ||
| return false | ||
| } | ||
|
|
||
| if (match[protocolMatch] !== 'ipfs') { | ||
| return false | ||
| } | ||
|
|
||
| let hash = match[hashMatch] | ||
|
|
||
| if (hash && pattern === subdomainGatewayPattern) { | ||
| // when doing checks for subdomain context | ||
| // ensure hash is case-insensitive | ||
| // (browsers force-lowercase authority compotent anyway) | ||
| hash = hash.toLowerCase() | ||
| } | ||
|
|
||
| return isCID(hash) | ||
| } | ||
|
|
||
| function isIpns (input, pattern, protocolMatch = defaultProtocolMatch, hashMatch) { | ||
| const formatted = convertToString(input) | ||
| if (!formatted) { | ||
| return false | ||
| } | ||
| const match = formatted.match(pattern) | ||
| if (!match) { | ||
| return false | ||
| } | ||
|
|
||
| if (match[protocolMatch] !== 'ipns') { | ||
| return false | ||
| } | ||
|
|
||
| let ipnsId = match[hashMatch] | ||
|
|
||
| if (ipnsId && pattern === subdomainGatewayPattern) { | ||
| // when doing checks for subdomain context | ||
| // ensure ipnsId is case-insensitive | ||
| // (browsers force-lowercase authority compotent anyway) | ||
| ipnsId = ipnsId.toLowerCase() | ||
| // Check if it is cidv1 | ||
| if (isCID(ipnsId)) return true | ||
| // Check if it looks like FQDN | ||
| try { | ||
| if (!ipnsId.includes('.') && ipnsId.includes('-')) { | ||
| // name without tld, assuming its inlined into a single DNS label | ||
| // (https://github.com/ipfs/in-web-browsers/issues/169) | ||
| // en-wikipedia--on--ipfs-org → en.wikipedia-on-ipfs.org | ||
| ipnsId = ipnsId.replace(/--/g, '@').replace(/-/g, '.').replace(/@/g, '-') | ||
| } | ||
| // URL implementation in web browsers forces lowercase of the hostname | ||
| const { hostname } = new URL(`http://${ipnsId}`) // eslint-disable-line no-new | ||
| // Check if potential FQDN has an explicit TLD | ||
| return fqdnWithTld.test(hostname) | ||
| } catch (e) { | ||
| return false | ||
| } | ||
| } | ||
|
|
||
| return true | ||
| } | ||
|
|
||
| function isString (input) { | ||
| return typeof input === 'string' | ||
| } | ||
|
|
||
| function convertToString (input) { | ||
| if (input instanceof Uint8Array) { | ||
| return uint8ArrayToString(input, 'base58btc') | ||
| } | ||
|
|
||
| if (isString(input)) { | ||
| return input | ||
| } | ||
|
|
||
| return false | ||
| } | ||
|
|
||
| const ipfsSubdomain = (url) => isIpfs(url, subdomainGatewayPattern, subdomainProtocolMatch, subdomainIdMatch) | ||
| const ipnsSubdomain = (url) => isIpns(url, subdomainGatewayPattern, subdomainProtocolMatch, subdomainIdMatch) | ||
| const subdomain = (url) => ipfsSubdomain(url) || ipnsSubdomain(url) | ||
|
|
||
| const ipfsUrl = (url) => isIpfs(url, pathGatewayPattern) || ipfsSubdomain(url) | ||
| const ipnsUrl = (url) => isIpns(url, pathGatewayPattern) || ipnsSubdomain(url) | ||
| const url = (url) => ipfsUrl(url) || ipnsUrl(url) || subdomain(url) | ||
|
|
||
| const path = (path) => isIpfs(path, pathPattern) || isIpns(path, pathPattern) | ||
|
|
||
| module.exports = { | ||
| multihash: isMultihash, | ||
| multiaddr: isMultiaddr, | ||
| peerMultiaddr: isPeerMultiaddr, | ||
| cid: isCID, | ||
| base32cid: (cid) => (isMultibase(cid) === 'base32' && isCID(cid)), | ||
| ipfsSubdomain, | ||
| ipnsSubdomain, | ||
| subdomain, | ||
| subdomainGatewayPattern, | ||
| ipfsUrl, | ||
| ipnsUrl, | ||
| url, | ||
| pathGatewayPattern: pathGatewayPattern, | ||
| ipfsPath: (path) => isIpfs(path, pathPattern), | ||
| ipnsPath: (path) => isIpns(path, pathPattern), | ||
| path, | ||
| pathPattern, | ||
| urlOrPath: (x) => url(x) || path(x), | ||
| cidPath: path => isString(path) && !isCID(path) && isIpfs(`/ipfs/${path}`, pathPattern) | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -107,6 +107,12 @@ describe('ipfs path', () => { | |||||
| done() | ||||||
| }) | ||||||
|
|
||||||
| it('isIPFS.urlOrPath should match an IANA-schema compliant ipfs url', (done) => { | ||||||
| const actual = isIPFS.urlOrPath('ipfs://QmYHNYAaYK5hm3ZhZFx5W9H6xydKDGimjdgJMrMSdnctEm') | ||||||
| expect(actual).to.equal(true) | ||||||
| done() | ||||||
| }) | ||||||
|
|
||||||
| it('isIPFS.urlOrPath should match ipns url', (done) => { | ||||||
| const actual = isIPFS.urlOrPath('http://ipfs.io/ipns/foo.bar.com') | ||||||
| expect(actual).to.equal(true) | ||||||
|
|
@@ -153,7 +159,12 @@ describe('ipfs path', () => { | |||||
| }) | ||||||
|
|
||||||
| it('isIPFS.cidPath should not match an IPFS path', () => { | ||||||
| expect(isIPFS.cidPath('/ipfs/QmYHNYAaYK5hm3ZhZFx5W9H6xydKDGimjdgJMrMSdnctEm')).to.be.false() | ||||||
| }) | ||||||
| }) | ||||||
|
|
||||||
| describe('ipns path', () => { | ||||||
| it('isIPFS.urlOrPath should match an IANA-schema compliant ipns url', () => { | ||||||
| expect(isIPFS.urlOrPath('ipns://QmYHNYAaYK5hm3ZhZFx5W9H6xydKDGimjdgJMrMSdnctEm')).to.be.true() | ||||||
|
There was a problem hiding this comment.
Suggested change
ipns:// is not valid. Only keys and domains are valid. |
||||||
| }) | ||||||
| }) | ||||||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this should return as invalid since it should have a CID as the "domain" when "ipfs" is the protocol