Skip to content

feat: Migrate PreferencesManager to DataStore with Encrypted Storage#477

Open
PavloNetrebchuk wants to merge 1 commit intoopenedx:developfrom
raccoongang:feat/migration_to_data_store
Open

feat: Migrate PreferencesManager to DataStore with Encrypted Storage#477
PavloNetrebchuk wants to merge 1 commit intoopenedx:developfrom
raccoongang:feat/migration_to_data_store

Conversation

@PavloNetrebchuk
Copy link
Contributor

Migrates PreferencesManager from SharedPreferences to Jetpack DataStore Preferences with AES-256-GCM encryption for sensitive data using Android Keystore.

DataStore Migration:

  • Replaced SharedPreferences with DataStore
  • Introduced type-safe preference keys using stringPreferencesKey, longPreferencesKey, booleanPreferencesKey
  • Updated clearCorePreferences() and clearCalendarPreferences() to suspend functions
  • Added androidx.datastore:datastore-preferences:1.2.0 dependency

Encryption Implementation:

  • Created DataStoreEncryption class using Android Keystore + AES-256-GCM
  • Encrypted sensitive fields:
    • accessToken
    • refreshToken
    • pushToken
    • user (JSON)
    • profile (JSON)

Security Details:

  • Algorithm : AES-256-GCM
  • Key Storage : Android Keystore (hardware-backed when available)
  • IV Length : 2 bytes (random per encryption)
  • Auth Tag : 128 bits
  • Format : Base64(IV + ciphertext + auth_tag)

Motivation

SharedPreferences limitations:

  • No encryption for sensitive data
  • Synchronous API blocks the calling thread
  • No type safety for keys

New implementation advantages:

  • Sensitive tokens encrypted at rest
  • Keys stored in Android Keystore (never exportable)
  • Type-safe key definitions
  • Guaranteed atomic writes

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Feb 5, 2026
@openedx-webhooks
Copy link

Thanks for the pull request, @PavloNetrebchuk!

This repository is currently maintained by @openedx/openedx-mobile-maintainers.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details
Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

open-source-contribution PR author is not from Axim or 2U

Projects

Status: Needs Triage

Development

Successfully merging this pull request may close these issues.

2 participants