chore: release 1.2.6

CHANGELOG.md

@@ -6,6 +6,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.2.6] - 2023-10-09
+### Added
+- JSON schemas for common objects
+### Changed
+- Additional Github proof location (proof.md)
+### Fixed
+- IRC compatibility with ASP profiles
+- IRC profile display value
+- Lobste.rs profile URL value
+
 ## [1.2.5] - 2023-10-05
 ### Added
 - Support for theme color

dist/doip.core.js

@@ -3102,7 +3102,7 @@ var doip = (function (exports, openpgp$1, fetcher) {
         name: 'IRC'
       },
       profile: {
-        display: `irc://${match[1]}/${match[2]}`,
+        display: `${match[1]}/${match[2]}`,
         uri,
         qr: null
       },
@@ -3901,7 +3901,7 @@ var doip = (function (exports, openpgp$1, fetcher) {
   limitations under the License.
   */
 
-  const reURI$b = /^https:\/\/lobste\.rs\/u\/(.*)\/?/;
+  const reURI$b = /^https:\/\/lobste\.rs\/(:?~|u\/)(.*)\/?/;
 
   /**
    * @function
@@ -3918,7 +3918,7 @@ var doip = (function (exports, openpgp$1, fetcher) {
       },
       profile: {
         display: match[1],
-        uri,
+        uri: `https://lobste.rs/~${match[1]}`,
         qr: null
       },
       claim: {
@@ -3927,11 +3927,11 @@ var doip = (function (exports, openpgp$1, fetcher) {
       },
       proof: {
         request: {
-          uri: `https://lobste.rs/u/${match[1]}.json`,
+          uri: `https://lobste.rs/~${match[1]}.json`,
           fetcher: Fetcher.HTTP,
           accessRestriction: ProofAccessRestriction.NOCORS,
           data: {
-            url: `https://lobste.rs/u/${match[1]}.json`,
+            url: `https://lobste.rs/~${match[1]}.json`,
             format: ProofFormat.JSON
           }
         },
@@ -3949,6 +3949,10 @@ var doip = (function (exports, openpgp$1, fetcher) {
   }
 
   const tests$b = [
+    {
+      uri: 'https://lobste.rs/~Alice',
+      shouldMatch: true
+    },
     {
       uri: 'https://lobste.rs/u/Alice',
       shouldMatch: true
@@ -3957,6 +3961,10 @@ var doip = (function (exports, openpgp$1, fetcher) {
       uri: 'https://lobste.rs/u/Alice/',
       shouldMatch: true
     },
+    {
+      uri: 'https://domain.org/~Alice',
+      shouldMatch: false
+    },
     {
       uri: 'https://domain.org/u/Alice',
       shouldMatch: false
@@ -4380,12 +4388,20 @@ var doip = (function (exports, openpgp$1, fetcher) {
         response: {
           format: ProofFormat.JSON
         },
-        target: [{
+        target: [
-          format: ClaimFormat.URI,
+          {
-          encoding: EntityEncodingFormat.PLAIN,
+            format: ClaimFormat.URI,
-          relation: ClaimRelation.CONTAINS,
+            encoding: EntityEncodingFormat.PLAIN,
-          path: ['files', 'openpgp.md', 'content']
+            relation: ClaimRelation.CONTAINS,
-        }]
+            path: ['files', 'proof.md', 'content']
+          },
+          {
+            format: ClaimFormat.URI,
+            encoding: EntityEncodingFormat.PLAIN,
+            relation: ClaimRelation.CONTAINS,
+            path: ['files', 'openpgp.md', 'content']
+          }
+        ]
       }
     })
   }
@@ -9955,6 +9971,388 @@ var doip = (function (exports, openpgp$1, fetcher) {
     parse: parse
   });
 
+  /*
+  Copyright 2023 Yarmo Mackenbach
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+  */
+  const profile = {
+    $schema: 'https://json-schema.org/draft/2020-12/schema',
+    $id: 'https://spec.keyoxide.org/2/profile.schema.json',
+    title: 'Profile',
+    description: 'Keyoxide profile with personas',
+    type: 'object',
+    properties: {
+      profileVersion: {
+        description: 'The version of the profile',
+        type: 'integer'
+      },
+      profileType: {
+        description: 'The type of the profile [openpgp, asp]',
+        type: 'string'
+      },
+      identifier: {
+        description: 'Identifier of the profile (email, fingerprint, URI)',
+        type: 'string'
+      },
+      personas: {
+        description: 'The personas inside the profile',
+        type: 'array',
+        items: {
+          $ref: 'https://spec.keyoxide.org/2/persona.schema.json'
+        },
+        minItems: 1,
+        uniqueItems: true
+      },
+      primaryPersonaIndex: {
+        description: 'The index of the primary persona',
+        type: 'integer'
+      },
+      publicKey: {
+        description: 'The cryptographic key associated with the profile',
+        type: 'object',
+        properties: {
+          keyType: {
+            description: 'The type of cryptographic key [eddsa, es256, openpgp, none]',
+            type: 'string'
+          },
+          encoding: {
+            description: 'The encoding of the cryptographic key [pem, jwk, armored_pgp, none]',
+            type: 'string'
+          },
+          encodedKey: {
+            description: 'The encoded cryptographic key (PEM, stringified JWK, ...)',
+            type: ['string', 'null']
+          },
+          fetch: {
+            description: 'Details on how to fetch the public key',
+            type: 'object',
+            properties: {
+              method: {
+                description: 'The method to fetch the key [aspe, hkp, wkd, http, none]',
+                type: 'string'
+              },
+              query: {
+                description: 'The query to fetch the key',
+                type: ['string', 'null']
+              },
+              resolvedUrl: {
+                description: 'The URL the method eventually resolved to',
+                type: ['string', 'null']
+              }
+            }
+          }
+        },
+        required: [
+          'keyType',
+          'fetch'
+        ]
+      },
+      verifiers: {
+        description: 'A list of links to verifiers',
+        type: 'array',
+        items: {
+          type: 'object',
+          properties: {
+            name: {
+              description: 'Name of the verifier site',
+              type: 'string'
+            },
+            url: {
+              description: 'URL to the profile page on the verifier site',
+              type: 'string'
+            }
+          }
+        },
+        uniqueItems: true
+      }
+    },
+    required: [
+      'profileVersion',
+      'profileType',
+      'identifier',
+      'personas',
+      'primaryPersonaIndex',
+      'publicKey',
+      'verifiers'
+    ],
+    additionalProperties: false
+  };
+
+  const persona = {
+    $schema: 'https://json-schema.org/draft/2020-12/schema',
+    $id: 'https://spec.keyoxide.org/2/persona.schema.json',
+    title: 'Profile',
+    description: 'Keyoxide persona with identity claims',
+    type: 'object',
+    properties: {
+      identifier: {
+        description: 'Identifier of the persona',
+        type: ['string', 'null']
+      },
+      name: {
+        description: 'Name of the persona',
+        type: 'string'
+      },
+      email: {
+        description: 'Email address of the persona',
+        type: ['string', 'null']
+      },
+      description: {
+        description: 'Description of the persona',
+        type: ['string', 'null']
+      },
+      avatarUrl: {
+        description: 'URL to an avatar image',
+        type: ['string', 'null']
+      },
+      themeColor: {
+        description: 'Profile page theme color',
+        type: ['string', 'null']
+      },
+      isRevoked: {
+        type: 'boolean'
+      },
+      claims: {
+        description: 'A list of identity claims',
+        type: 'array',
+        items: {
+          $ref: 'https://spec.keyoxide.org/2/claim.schema.json'
+        },
+        uniqueItems: true
+      }
+    },
+    required: [
+      'name',
+      'claims'
+    ],
+    additionalProperties: false
+  };
+
+  const claim = {
+    $schema: 'https://json-schema.org/draft/2020-12/schema',
+    $id: 'https://spec.keyoxide.org/2/claim.schema.json',
+    title: 'Identity claim',
+    description: 'Verifiable online identity claim',
+    type: 'object',
+    properties: {
+      claimVersion: {
+        description: 'The version of the claim',
+        type: 'integer'
+      },
+      uri: {
+        description: 'The claim URI',
+        type: 'string'
+      },
+      proofs: {
+        description: 'The proofs that would verify the claim',
+        type: 'array',
+        items: {
+          type: 'string'
+        },
+        minItems: 1,
+        uniqueItems: true
+      },
+      matches: {
+        description: 'Service providers matched to the claim',
+        type: 'array',
+        items: {
+          $ref: 'https://spec.keyoxide.org/2/serviceprovider.schema.json'
+        },
+        uniqueItems: true
+      },
+      status: {
+        type: 'integer',
+        description: 'Claim status code'
+      },
+      display: {
+        type: 'object',
+        properties: {
+          profileName: {
+            type: 'string',
+            description: 'Account name to display in the user interface'
+          },
+          profileUrl: {
+            type: ['string', 'null'],
+            description: 'Profile URL to link to in the user interface'
+          },
+          proofUrl: {
+            type: ['string', 'null'],
+            description: 'Proof URL to link to in the user interface'
+          },
+          serviceProviderName: {
+            type: ['string', 'null'],
+            description: 'Name of the service provider to display in the user interface'
+          },
+          serviceProviderId: {
+            type: ['string', 'null'],
+            description: 'Id of the service provider'
+          }
+        }
+      }
+    },
+    required: [
+      'claimVersion',
+      'uri',
+      'proofs',
+      'status',
+      'display'
+    ],
+    additionalProperties: false
+  };
+
+  const serviceprovider = {
+    $schema: 'https://json-schema.org/draft/2020-12/schema',
+    $id: 'https://spec.keyoxide.org/2/serviceprovider.schema.json',
+    title: 'Service provider',
+    description: 'A service provider that can be matched to identity claims',
+    type: 'object',
+    properties: {
+      about: {
+        description: 'Details about the service provider',
+        type: 'object',
+        properties: {
+          name: {
+            description: 'Full name of the service provider',
+            type: 'string'
+          },
+          id: {
+            description: 'Identifier of the service provider (no whitespace or symbols, lowercase)',
+            type: 'string'
+          },
+          homepage: {
+            description: 'URL to the homepage of the service provider',
+            type: ['string', 'null']
+          }
+        }
+      },
+      profile: {
+        description: 'What the profile would look like if the match is correct',
+        type: 'object',
+        properties: {
+          display: {
+            description: 'Profile name to be displayed',
+            type: 'string'
+          },
+          uri: {
+            description: 'URI or URL for public access to the profile',
+            type: 'string'
+          },
+          qr: {
+            description: 'URI or URL associated with the profile usually served as a QR code',
+            type: ['string', 'null']
+          }
+        }
+      },
+      claim: {
+        description: 'Details from the claim matching process',
+        type: 'object',
+        properties: {
+          uriRegularExpression: {
+            description: 'Regular expression used to parse the URI',
+            type: 'string'
+          },
+          uriIsAmbiguous: {
+            description: 'Whether this match automatically excludes other matches',
+            type: 'boolean'
+          }
+        }
+      },
+      proof: {
+        description: 'Information for the proof verification process',
+        type: 'object',
+        properties: {
+          request: {
+            description: 'Details to request the potential proof',
+            type: 'object',
+            properties: {
+              uri: {
+                description: 'Location of the proof',
+                type: ['string', 'null']
+              },
+              accessRestriction: {
+                description: 'Type of access restriction [none, nocors, granted, server]',
+                type: 'string'
+              },
+              fetcher: {
+                description: 'Name of the fetcher to use',
+                type: 'string'
+              },
+              data: {
+                description: 'Data needed by the fetcher or proxy to request the proof',
+                type: 'object',
+                additionalProperties: true
+              }
+            }
+          },
+          response: {
+            description: 'Details about the expected response',
+            type: 'object',
+            properties: {
+              format: {
+                description: 'Expected format of the proof [text, json]',
+                type: 'string'
+              }
+            }
+          },
+          target: {
+            description: 'Details about the target located in the response',
+            type: 'array',
+            items: {
+              type: 'object',
+              properties: {
+                format: {
+                  description: 'How is the proof formatted [uri, fingerprint]',
+                  type: 'string'
+                },
+                encoding: {
+                  description: 'How is the proof encoded [plain, html, xml]',
+                  type: 'string'
+                },
+                relation: {
+                  description: 'How are the response and the target related [contains, equals]',
+                  type: 'string'
+                },
+                path: {
+                  description: 'Path to the target location if the response is JSON',
+                  type: 'array',
+                  items: {
+                    type: 'string'
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    required: [
+      'about',
+      'profile',
+      'claim',
+      'proof'
+    ],
+    additionalProperties: false
+  };
+
+  var schemas = /*#__PURE__*/Object.freeze({
+    __proto__: null,
+    claim: claim,
+    persona: persona,
+    profile: profile,
+    serviceprovider: serviceprovider
+  });
+
   exports.fetcher = fetcher__namespace;
   exports.Claim = Claim;
   exports.Persona = Persona;
@@ -9966,6 +10364,7 @@ var doip = (function (exports, openpgp$1, fetcher) {
   exports.enums = enums;
   exports.openpgp = openpgp;
   exports.proofs = proofs;
+  exports.schemas = schemas;
   exports.signatures = signatures;
   exports.utils = utils$9;
   exports.verifications = verifications;

dist/doip.fetchers.js

@@ -2728,7 +2728,7 @@ var doipFetchers = (function (exports) {
 	 * doip.js library version
 	 * @constant {string}
 	 */
-	const version = '1.2.5';
+	const version = '1.2.6';
 
 	/*
 	Copyright 2022 Yarmo Mackenbach
@@ -23629,7 +23629,7 @@ var doipFetchers = (function (exports) {
 	        showErrors: false,
 	        debug: false
 	      });
-	      const reKey = /[a-zA-Z0-9\-_]+\s+:\s(openpgp4fpr:.*)/;
+	      const reKey = /[a-zA-Z0-9\-_]+\s+:\s(openpgp4fpr|aspe:.*)/;
 	      const reEnd = /End\sof\s.*\staxonomy./;
 	      const keys = [];
 

dist/doip.fetchers.minimal.js

@@ -2698,7 +2698,7 @@ var doipFetchers = (function (exports) {
 	 * doip.js library version
 	 * @constant {string}
 	 */
-	const version = '1.2.5';
+	const version = '1.2.6';
 
 	/*
 	Copyright 2022 Yarmo Mackenbach

package.json

@@ -1,6 +1,6 @@
 {
   "name": "doipjs",
-  "version": "1.2.5",
+  "version": "1.2.6",
   "description": "Decentralized Online Identity Proofs library in Node.js",
   "type": "module",
   "main": "./src/index.js",

src/constants.js

@@ -22,4 +22,4 @@ limitations under the License.
  * doip.js library version
  * @constant {string}
  */
-export const version = '1.2.5'
+export const version = '1.2.6'