Api, Cli, Desktop: Resolves #16054: Add fail-closed guardrails for locked notes #16098
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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,26 @@ | ||
| import Note from '@joplin/lib/models/Note'; | ||
| import Setting from '@joplin/lib/models/Setting'; | ||
| import { setupDatabaseAndSynchronizer, switchClient } from '@joplin/lib/testing/test-utils'; | ||
| import { setupCommandForTesting, setupApplication } from './utils/testUtils'; | ||
| const Command = require('./command-cat'); | ||
|
|
||
| describe('command-cat', () => { | ||
|
|
||
| beforeEach(async () => { | ||
| await setupDatabaseAndSynchronizer(1); | ||
| await switchClient(1); | ||
| await setupApplication(); | ||
| }); | ||
|
|
||
| it('should refuse to display a locked note', async () => { | ||
| Setting.setValue('featureFlag.noteLock', true); | ||
| const note = await Note.save({ title: 'hello', body: 'ciphertext', is_locked: 1, parent_id: '' }); | ||
|
|
||
| let output = ''; | ||
| const command = setupCommandForTesting(Command, (text: string) => { output += text; }); | ||
|
|
||
| await expect(command.action({ note: note.id, options: {} })).rejects.toThrow('locked note'); | ||
| expect(output).toBe(''); | ||
| }); | ||
|
|
||
| }); |
This file contains hidden or 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 hidden or 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,29 @@ | ||
| import * as fs from 'fs-extra'; | ||
| import Note from '@joplin/lib/models/Note'; | ||
| import Setting from '@joplin/lib/models/Setting'; | ||
| import { setupDatabaseAndSynchronizer, switchClient } from '@joplin/lib/testing/test-utils'; | ||
| import { setupCommandForTesting, setupApplication } from './utils/testUtils'; | ||
| const Command = require('./command-edit'); | ||
|
|
||
| describe('command-edit', () => { | ||
|
|
||
| beforeEach(async () => { | ||
| await setupDatabaseAndSynchronizer(1); | ||
| await switchClient(1); | ||
| await setupApplication(); | ||
| }); | ||
|
|
||
| it('should refuse to edit a locked note without writing a temp file', async () => { | ||
| Setting.setValue('featureFlag.noteLock', true); | ||
| const note = await Note.save({ title: 'hello', body: 'ciphertext', is_locked: 1, parent_id: '' }); | ||
| const tempDir = Setting.value('tempDir'); | ||
| await fs.ensureDir(tempDir); | ||
| const filesBefore = await fs.readdir(tempDir); | ||
|
|
||
| const command = setupCommandForTesting(Command); | ||
|
|
||
| await expect(command.action({ note: note.id })).rejects.toThrow('locked note'); | ||
| expect(await fs.readdir(tempDir)).toEqual(filesBefore); | ||
| }); | ||
|
|
||
| }); |
This file contains hidden or 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,44 @@ | ||
| import Note from '@joplin/lib/models/Note'; | ||
| import Setting from '@joplin/lib/models/Setting'; | ||
| import { setupDatabaseAndSynchronizer, switchClient } from '@joplin/lib/testing/test-utils'; | ||
| import { setupCommandForTesting, setupApplication } from './utils/testUtils'; | ||
| const Command = require('./command-set'); | ||
|
|
||
| describe('command-set', () => { | ||
|
|
||
| beforeEach(async () => { | ||
| await setupDatabaseAndSynchronizer(1); | ||
| await switchClient(1); | ||
| await setupApplication(); | ||
| }); | ||
|
|
||
| // This guard lives in BaseCommand.encryptionCheck, so it also covers attach, done, edit, ren and todo. | ||
| it.each([ | ||
| { label: 'refuse to change a locked note', flagEnabled: true, expectedError: 'Cannot change a locked note', expectedTitle: 'hello' }, | ||
| { label: 'change a locked note when note lock is disabled', flagEnabled: false, expectedError: null, expectedTitle: 'renamed' }, | ||
| ])('should $label', async ({ flagEnabled, expectedError, expectedTitle }) => { | ||
| Setting.setValue('featureFlag.noteLock', flagEnabled); | ||
| const note = await Note.save({ title: 'hello', body: 'ciphertext', is_locked: 1, parent_id: '' }); | ||
|
|
||
| const command = setupCommandForTesting(Command); | ||
| let error: string|null = null; | ||
| try { | ||
| await command.action({ note: note.id, name: 'title', value: 'renamed' }); | ||
| } catch (e) { | ||
| error = (e as Error).message; | ||
| } | ||
|
|
||
| expect(error).toBe(expectedError); | ||
| expect((await Note.load(note.id)).title).toBe(expectedTitle); | ||
| }); | ||
|
|
||
| it('should block changing the lock state of a plain note', async () => { | ||
| Setting.setValue('featureFlag.noteLock', true); | ||
| const note = await Note.save({ title: 'hello', body: 'plain', parent_id: '' }); | ||
|
|
||
| const command = setupCommandForTesting(Command); | ||
| await expect(command.action({ note: note.id, name: 'is_locked', value: '1' })).rejects.toThrow('The note lock state cannot be changed from the command line'); | ||
| expect((await Note.load(note.id)).is_locked).toBe(0); | ||
| }); | ||
|
|
||
| }); |
This file contains hidden or 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 hidden or 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 hidden or 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.
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.
It would be better to first check if any of the notes are locked before the loop, then grab the decrypted key before iterating the loop, so that the key remains available for bulk conversion.
Also, the validation above if the session is locked should apply when the noteLockKey is populated, not just when it is not