doipjs/test/keys.test.js

/*
Copyright 2021 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.
*/
import { expect, use } from 'chai'
import chaiAsPromised from 'chai-as-promised'
use(chaiAsPromised)

import { PublicKey } from 'openpgp'
import { keys } from '../src/index.js'

const pubKeyFingerprint = "3637202523e7c1309ab79e99ef2dc5827b445f4b"
const pubKeyEmail = "test@doip.rocks"

const pubKeyPlaintext = `-----BEGIN PGP PUBLIC KEY BLOCK-----

mQGNBF+036UBDACoxWRdp7rBAFB2l/+dxX0XA50NJC92EEacB5L0TnC0lP/MsNHv
fAv/A9vgTwrPudvcHdE/urAjQswfIU3LpFxbBOWNYWOv6ssrzBH4vVGMyxfu2GGu
b2mxjWj0eWXnWXnzkO5fscX2y0HqNjBZjDSkYohHZJTbz91NnxK3a8+Erpk+sgEH
hQH1h75SfaW6GZucuhenxgjwEiGz84UEVS0AEWD9yNgfWCsK/6HuIRnv5Jv5V9z9
bx9Ik7QNGBks3tpNmdbeaaadkHYZpF3Fm8mCoIt2+Xx9OvyuLssZnVkuQdj8C2/z
E45If4+pHRnRcCWXpDrHUWoJaeyGuTq5triePI6h/4lgr/m/du0O/lhOrr6MUhAe
7xc0B+X+bTF/balZmmlbk5bnDoZMzdH8caui5XrkuRif/I0nYPRnc9zrqWJDDO/p
nltpMPrUMTjoiXZ8DbJ4WMK7QPdsbG8Tz/Vl3wigEmwPLfEGifLpec5RXrti5Zd9
FiSOIOetP8p8MSMAEQEAAbRBWWFybW8gTWFja2VuYmFjaCAobWF0ZXJpYWwgZm9y
IHRlc3QgZnJhbWV3b3JrcykgPHRlc3RAZG9pcC5yb2Nrcz6JAhAEEwEKAHoCGwMF
CwkIBwIGFQoJCAsCBBYCAwECHgECF4AZGGh0dHBzOi8va2V5cy5vcGVucGdwLm9y
ZxYhBDY3ICUj58Ewmreeme8txYJ7RF9LBQJhhrogJxSAAAAAABAADnByb29mQGFy
aWFkbmUuaWRkbnM6ZG9pcC5yb2NrcwAKCRDvLcWCe0RfS6LbC/9mdVWS8qiZcM0b
tcekjGXXDKWggdeYVxHMcSCypvuI7Rha8vRKGnfvtY6Wy36YsW40u6vdaw4UIFGy
6Y/8RhaT6eN0EZ8t4VQv8HXyHeWqqQSfBpyU77spcxv27Wo24OhrI9ErmxXHAjqk
Hp46lA1nJjGRkzQs09KFRPd4nL4NInV1me1G8szxzowlLbRIZ3bNqhnPTeVOa779
j8aupCr0W08W0f6FxcDxGgQBT1ytLcc1nQdhgkXppTlso+JvOr2sjff4suSXY3gC
GcTGwRX15q3YDTv36KtlBlus2f4oGk1mjqZAESklrTHCfifZW102mkKBzZ+Y0EwN
B9ODBwJNrsbqBqXMs1wQkP81O3ihONwhz5XuykJF3G0VeoOy1zSL4ghZQ4/XkWyp
fCRSXrr7SZxIu7I8jfQrxc0k9XhpPI/gdlgRqoEG2lMyqFaWzyoI9dyoVwji78rg
8t7V+BjcvC8fJHgXUZxljqi2ZfcismJE6Hyn6qsdlNF9SKWOIIg=
=Csr+
-----END PGP PUBLIC KEY BLOCK-----`

const pubKeyWithOtherNotations = `-----BEGIN PGP PUBLIC KEY BLOCK-----

mDMEX9Mt6xYJKwYBBAHaRw8BAQdAch8jfp+8KHH5cy/t45GjPvl6dkEv2soIy9fo
Oe9DbP20EVlhcm1vJ3MgRXZpbCBUd2luiNsEExYIAIMCGwMFCwkIBwIGFQoJCAsC
BBYCAwECHgECF4AWIQTeePcduHH8EU2iM3aw5zJVrULhnwUCX9MuHBkUgAAAAAAN
AANldmlsQHlhcm1vLmV1eWVzMBSAAAAAABIAFXByb29mQG1ldGFjb2RlLmJpemRu
czp5YXJtby5ldT90eXBlPVRYVAAKCRCw5zJVrULhn4DtAQCVkyI8UxUbkxspXkWB
qUL+3uqCl9gTbNImhv/OxxJdEAEAqf8SJ9FSeAwgWhPHOidR1m+J6/qVdAJdp0HJ
Yn6RMQ8=
=Oo3X
-----END PGP PUBLIC KEY BLOCK-----`

const pubKeyWithRevokedUID = `-----BEGIN PGP PUBLIC KEY BLOCK-----

mI0EYLitOQEEAMUKTmcNdy46gjcuz0oRsUyq0BythQGSrcLvLGAyZIzKR8NZXZSA
UAIHuQkWVwqJjYPSRrTp8op8LZIHmhP3W3TgG5WHSOhcPeIYe1JTB0b7XceIIJ3p
/FfT9xFhWgeAVfAHQUcK/p4+mhvQRfDDf5Jbh/i37cY3iF5huNyXZYY9ABEBAAG0
F1lhcm1vJ3MgU3VwZXIgRXZpbCBUd2luiLYEMAEKACAWIQQKQsh7jbmy9ycMulRn
U1zbmU0aJAUCYLiu7QIdIAAKCRBnU1zbmU0aJGr1A/9VMS9xexufTLHenWCquAsL
cnzciPTvYy7h+OYAkXQEmzOcUcy9a71w5/ElEWubqySZuUUeB7Y8UHjowXOVF5Ty
BRyiSIiHmwXspjCtc5q97fWuuAiVdyHMWMSThuY+y+D4pxcfeO1lu5zND3vUUGjy
CJWtYDGTVQ41nLU4WM8NTIjOBBMBCgA4FiEECkLIe425svcnDLpUZ1Nc25lNGiQF
AmC4rgsCGwMFCwkIBwIGFQoJCAsCBBYCAwECHgECF4AACgkQZ1Nc25lNGiRSWQQA
wUM2h4uSyaOUT+qrL0/UTUqD3Mp0Ajg/n81S9GBcKhSxIK2RMIBCJbSw7nzdj2Ev
gCwd3DuI0Mqxiu29LtNN+bsEWZ6RbsrxgkgzQy2wyGf6DHS9W7GcliyIWnHSh/Jc
dTREbVl0aFXOTLh7JAoED31pf3uv372YJyQfjvqDlLC0EVlhcm1vJ3MgRXZpbCBU
d2luiM4EEwEKADgWIQQKQsh7jbmy9ycMulRnU1zbmU0aJAUCYLitOQIbAwULCQgH
AgYVCgkICwIEFgIDAQIeAQIXgAAKCRBnU1zbmU0aJMnBBACydud5WYsmD/Tvjxf6
MiOl/s0zMLZdk6ofEutMvcmN8PGri1hMqr2R2lTN+cH4HALWbixuDr1sYjOwt2eb
6e8ubOhEm30JGJE8eiM9jHRUgeRQZhPnj/ky/fZUcMY5fZPeti3q7kzBMRscuSbW
9v8AArWmybhfudyjf7Lhb5R3UriNBGC4rTkBBADVCDORKNEyjOQutpxvR8y1nBdy
VfCKQ0mUiV9/Z1PvhW3s98RyjDZcYURhgPXUD04EKtgH6ar6Q4pZovZmRL6Jz+82
4OWmFk4dzje/MLYIeV6hwq7IIeKzUy4NCl/aX7y0Hru/8fiBNPtu+ycIZSgNxDQQ
NwHRpZvplgOJ/cuCYwARAQABiLYEGAEKACAWIQQKQsh7jbmy9ycMulRnU1zbmU0a
JAUCYLitOQIbDAAKCRBnU1zbmU0aJIaRA/9Zz0u7zkwBVSTUcXLd3NwCmkzHnuQo
kRIDpwkXa08iG0GXBV/ZEPGNzPbaMCZVqqiVlf9+BxX1rnG6ENseGKPn8Q+RIKUb
Q+AZdYCbM0hdBjP4xdKZcpqak8ksb+aQFXjGacDL/XN4VrP+tBGxkqIqreoDcgIb
7t1hISc09hWrGQ==
=tVW7
-----END PGP PUBLIC KEY BLOCK-----`

describe('keys.fetch', () => {
  it('should be a function (1 argument)', () => {
    expect(keys.fetch).to.be.a('function')
    expect(keys.fetch).to.have.length(1)
  })
  it('should return a Key object when provided a valid fingerprint', async () => {
    expect(
      await keys.fetch(pubKeyFingerprint)
    ).to.be.instanceOf(PublicKey)
  }).timeout('12s')
  it('should return a Key object when provided a valid email address', async () => {
    expect(
      await keys.fetch(pubKeyEmail)
    ).to.be.instanceOf(PublicKey)
  }).timeout('12s')
  it('should reject when provided an invalid email address', () => {
    return expect(
      keys.fetch('invalid@doip.rocks')
    ).to.eventually.be.rejectedWith('Key does not exist or could not be fetched')
  }).timeout('12s')
})

describe('keys.fetchURI', () => {
  it('should be a function (1 argument)', () => {
    expect(keys.fetchURI).to.be.a('function')
    expect(keys.fetchURI).to.have.length(1)
  })
  it('should return a Key object when provided a hkp: uri', async () => {
    expect(
      await keys.fetchURI(`hkp:${pubKeyFingerprint}`)
    ).to.be.instanceOf(PublicKey)
  }).timeout('12s')
  it('should reject when provided an invalid uri', () => {
    return expect(
      keys.fetchURI(`inv:${pubKeyFingerprint}`)
    ).to.eventually.be.rejectedWith('Invalid URI protocol')
  }).timeout('12s')
})

describe('keys.fetchHKP', () => {
  it('should be a function (2 arguments)', () => {
    expect(keys.fetchHKP).to.be.a('function')
    expect(keys.fetchHKP).to.have.length(2)
  })
  it('should return a Key object when provided a valid fingerprint', async () => {
    expect(await keys.fetchHKP(pubKeyFingerprint)).to.be.instanceOf(
      PublicKey
    )
  }).timeout('12s')
  it('should return a Key object when provided a valid email address', async () => {
    expect(await keys.fetchHKP(pubKeyEmail)).to.be.instanceOf(
      PublicKey
    )
  }).timeout('12s')
  it('should reject when provided an invalid fingerprint', async () => {
    return expect(
      keys.fetchHKP('4637202523e7c1309ab79e99ef2dc5827b445f4b')
    ).to.eventually.be.rejectedWith(
      'Key does not exist or could not be fetched'
    )
  }).timeout('12s')
  it('should reject when provided an invalid email address', async () => {
    return expect(
      keys.fetchHKP('invalid@doip.rocks')
    ).to.eventually.be.rejectedWith(
      'Key does not exist or could not be fetched'
    )
  }).timeout('12s')
})

describe('keys.fetchPlaintext', () => {
  it('should be a function (1 argument)', () => {
    expect(keys.fetchPlaintext).to.be.a('function')
    expect(keys.fetchPlaintext).to.have.length(1)
  })
  it('should return a Key object', async () => {
    expect(await keys.fetchPlaintext(pubKeyPlaintext)).to.be.instanceOf(
      PublicKey
    )
  }).timeout('12s')
})

describe('keys.process', () => {
  it('should be a function (1 argument)', () => {
    expect(keys.process).to.be.a('function')
    expect(keys.process).to.have.length(1)
  })
  it('should return an object with specific keys', async () => {
    const pubKey = await keys.fetchPlaintext(pubKeyPlaintext)
    const obj = await keys.process(pubKey)
    expect(obj).to.have.keys([
      'users',
      'fingerprint',
      'primaryUserIndex',
      'key',
    ])
  })
  it('should ignore non-proof notations', async () => {
    const pubKey = await keys.fetchPlaintext(pubKeyWithOtherNotations)
    const obj = await keys.process(pubKey)
    expect(obj.users).to.be.lengthOf(1)
    expect(obj.users[0].claims).to.be.lengthOf(1)
    expect(obj.users[0].claims[0].uri).to.be.equal('dns:yarmo.eu?type=TXT')
  })
  it('should properly handle revoked UIDs', async () => {
    const pubKey = await keys.fetchPlaintext(pubKeyWithRevokedUID)
    const obj = await keys.process(pubKey)
    expect(obj.users).to.be.lengthOf(2)
    expect(obj.users[0].userData.isRevoked).to.be.true
    expect(obj.users[1].userData.isRevoked).to.be.false
  })
})