Do a naive check for null bytes after JSON.stringify on doc lines

This commit is contained in:
James Allen 2017-02-27 09:55:04 +01:00
parent 1ce51c45bf
commit 60f3393c44
2 changed files with 53 additions and 20 deletions

View file

@ -31,6 +31,8 @@ module.exports = RedisManager =
timer.done()
_callback(error)
docLines = JSON.stringify(docLines)
if docLines.indexOf("\u0000") != -1
return callback(new Error("null bytes found in doc lines"))
docHash = RedisManager._computeHash(docLines)
logger.log project_id:project_id, doc_id:doc_id, version: version, hash:docHash, "putting doc in redis"
ranges = RedisManager._serializeRanges(ranges)
@ -151,6 +153,8 @@ module.exports = RedisManager =
jsonOps = appliedOps.map (op) -> JSON.stringify op
multi = rclient.multi()
newDocLines = JSON.stringify(docLines)
if newDocLines.indexOf("\u0000") != -1
return callback(new Error("null bytes found in doc lines"))
newHash = RedisManager._computeHash(newDocLines)
multi.eval setScript, 1, keys.docLines(doc_id:doc_id), newDocLines
multi.set keys.docVersion(doc_id:doc_id), newVersion

View file

@ -12,26 +12,30 @@ describe "RedisManager", ->
auth: () ->
exec: sinon.stub()
@rclient.multi = () => @rclient
@RedisManager = SandboxedModule.require modulePath, requires:
"./RedisBackend":
createClient: () => @rclient
"./RedisKeyBuilder":
blockingKey: ({doc_id}) -> "Blocking:#{doc_id}"
docLines: ({doc_id}) -> "doclines:#{doc_id}"
docOps: ({doc_id}) -> "DocOps:#{doc_id}"
docVersion: ({doc_id}) -> "DocVersion:#{doc_id}"
docHash: ({doc_id}) -> "DocHash:#{doc_id}"
projectKey: ({doc_id}) -> "ProjectId:#{doc_id}"
pendingUpdates: ({doc_id}) -> "PendingUpdates:#{doc_id}"
docsInProject: ({project_id}) -> "DocsIn:#{project_id}"
ranges: ({doc_id}) -> "Ranges:#{doc_id}"
"logger-sharelatex": @logger = { error: sinon.stub(), log: sinon.stub(), warn: sinon.stub() }
"settings-sharelatex": {documentupdater: {logHashErrors: {write:true, read:true}}}
"./Metrics": @metrics =
inc: sinon.stub()
Timer: class Timer
done: () ->
"./Errors": Errors
@RedisManager = SandboxedModule.require modulePath,
requires:
"./RedisBackend":
createClient: () => @rclient
"./RedisKeyBuilder":
blockingKey: ({doc_id}) -> "Blocking:#{doc_id}"
docLines: ({doc_id}) -> "doclines:#{doc_id}"
docOps: ({doc_id}) -> "DocOps:#{doc_id}"
docVersion: ({doc_id}) -> "DocVersion:#{doc_id}"
docHash: ({doc_id}) -> "DocHash:#{doc_id}"
projectKey: ({doc_id}) -> "ProjectId:#{doc_id}"
pendingUpdates: ({doc_id}) -> "PendingUpdates:#{doc_id}"
docsInProject: ({project_id}) -> "DocsIn:#{project_id}"
ranges: ({doc_id}) -> "Ranges:#{doc_id}"
"logger-sharelatex": @logger = { error: sinon.stub(), log: sinon.stub(), warn: sinon.stub() }
"settings-sharelatex": {documentupdater: {logHashErrors: {write:true, read:true}}}
"./Metrics": @metrics =
inc: sinon.stub()
Timer: class Timer
done: () ->
"./Errors": Errors
globals:
JSON: @JSON = JSON
@doc_id = "doc-id-123"
@project_id = "project-id-123"
@callback = sinon.stub()
@ -318,6 +322,19 @@ describe "RedisManager", ->
it "should call the callback", ->
@callback.called.should.equal true
describe "with null bytes in the serialized doc lines", ->
beforeEach ->
@RedisManager.getDocVersion.withArgs(@doc_id).yields(null, @version - @ops.length)
@_stringify = JSON.stringify
@JSON.stringify = () -> return '["bad bytes! \u0000 <- here"]'
@RedisManager.updateDocument @doc_id, @lines, @version, @ops, @ranges, @callback
afterEach ->
@JSON.stringify = @_stringify
it "should call the callback with an error", ->
@callback.calledWith(new Error("null bytes found in doc lines")).should.equal true
describe "putDocInMemory", ->
beforeEach ->
@rclient.set = sinon.stub()
@ -391,6 +408,18 @@ describe "RedisManager", ->
@logger.error.calledWith()
.should.equal true
describe "with null bytes in the serialized doc lines", ->
beforeEach ->
@_stringify = JSON.stringify
@JSON.stringify = () -> return '["bad bytes! \u0000 <- here"]'
@RedisManager.putDocInMemory @project_id, @doc_id, @lines, @version, @ranges, @callback
afterEach ->
@JSON.stringify = @_stringify
it "should call the callback with an error", ->
@callback.calledWith(new Error("null bytes found in doc lines")).should.equal true
describe "removeDocFromMemory", ->
beforeEach (done) ->
@rclient.del = sinon.stub()