Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Resolves #1180 Schema version auto populated when omitted in secretariat endpoints #1191

Merged
merged 2 commits into from
Mar 5, 2024
Merged

Resolves #1180 Schema version auto populated when omitted in secretariat endpoints #1191

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
788a413
#1180 schema version no longer required for secretariat CVE endpoints…
jdaigneau5 Mar 4, 2024
6505807
#1180 set ajv validation to only show one error at a time
jdaigneau5 Mar 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/constants/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ function getConstants () {
* @lends defaults
*/
const defaults = {
SCHEMA_VERSION: '5.1',
MONGOOSE_VALIDATION: {
Org_policies_id_quota_min: 0,
Org_policies_id_quota_min_message: 'Org.policies.id_quota cannot be a negative number.',
Expand Down
20 changes: 10 additions & 10 deletions src/middleware/middleware.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ const argon2 = require('argon2')
const logger = require('./logger')
const Ajv = require('ajv')
const addFormats = require('ajv-formats')
const ajv = new Ajv({ allErrors: true })
const ajv = new Ajv({ allErrors: false })
addFormats(ajv)
const validate = ajv.compile(cveSchemaV5)
const uuid = require('uuid')
Expand Down Expand Up @@ -309,9 +309,14 @@ async function cnaMustOwnID (req, res, next) {
}

function validateCveJsonSchema (req, res, next) {
const CONSTANTS = getConstants()
const cve = req.body
const cveVersion = cve.dataVersion
let cveState = cve.cveMetadata

if (!cve.dataVersion) {
cve.dataVersion = CONSTANTS.SCHEMA_VERSION
}

if (cveState === undefined) {
logger.error(JSON.stringify({ uuid: req.ctx.uuid, message: 'CVE JSON schema validation FAILED.' }))
return res.status(400).json(error.invalidJsonSchema(['instance.cveMetadata is not defined']))
Expand All @@ -321,16 +326,11 @@ function validateCveJsonSchema (req, res, next) {
logger.info({ uuid: req.ctx.uuid, message: 'Validating CVE JSON schema.' })
let result

if (cveVersion === '5.1') {
if (['PUBLISHED', 'RESERVED', 'REJECTED'].includes(cveState)) {
result = validate(cve)
} else {
logger.error(JSON.stringify({ uuid: req.ctx.uuid, message: 'CVE JSON schema validation FAILED.' }))
return res.status(400).json(error.invalidJsonSchema(['instance.cveMetadata.state is not one of enum values']))
}
if (['PUBLISHED', 'RESERVED', 'REJECTED'].includes(cveState)) {
result = validate(cve)
Fixed Show fixed Hide fixed
} else {
logger.error(JSON.stringify({ uuid: req.ctx.uuid, message: 'CVE JSON schema validation FAILED.' }))
return res.status(400).json(error.invalidJsonSchema(['instance.dataVersion is not one of enum values']))
return res.status(400).json(error.invalidJsonSchema(['instance.cveMetadata.state is not one of enum values']))
}

if (result) {
Expand Down
21 changes: 0 additions & 21 deletions test/unit-tests/middleware/validateJsonSchema5.0.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ const cveMetadataFail5 = require('../../schemas/5.0/' + cveId5 + '_fail_cveMetad
const cveRejectedFail5 = require('../../schemas/5.0/' + cveId5 + '_rejected_fail.json')
const cveReservedFail5 = require('../../schemas/5.0/' + cveId5 + '_reserved_fail.json')
const cvePublishedFail5 = require('../../schemas/5.0/' + cveId5 + '_published_fail.json')
const cveVersionFail5 = require('../../schemas/5.0/' + cveId5 + '_version_fail.json')

app.route('/api/test/mw/schema5')
.post(middleware.validateCveJsonSchema, (req, res) => {
Expand Down Expand Up @@ -124,26 +123,6 @@ describe('Test the JSON schema 5.0 validation middleware', () => {
done()
})
})

it('Json validator fails because invalid data version', (done) => {
chai.request(app)
.post('/api/test/mw/schema5')
.set(mwFixtures.secretariatHeaders)
.send(cveVersionFail5)
.end((err, res) => {
if (err) {
done(err)
}

expect(res).to.have.status(400)
expect(res).to.have.property('body').and.to.be.a('object')
expect(res.body).to.have.property('message').and.to.be.a('string')
expect(res.body.message).to.equal('CVE JSON schema validation FAILED.')
expect(res.body.details).to.have.property('errors').and.to.be.an('array')
expect(res.body.details.errors[0]).to.have.string('instance.dataVersion is not one of enum values')
done()
})
})
})

context('Positive Tests', () => {
Expand Down
Loading