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.

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

Update to Argon2 #42

Open
wants to merge 13 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
41 changes: 31 additions & 10 deletions operate/account/user.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,21 +23,22 @@
from dataclasses import dataclass
from pathlib import Path

import argon2

from operate.resource import LocalResource


def sha256(string: str) -> str:
"""Get SHA256 hexdigest of a string."""
sh256 = hashlib.sha256()
sh256.update(string.encode())
return sh256.hexdigest()
def argon2id(password: str) -> str:
"""Get Argon2id digest of a password."""
ph = argon2.PasswordHasher() # Defaults to Argon2id
return ph.hash(password)


@dataclass
class UserAccount(LocalResource):
"""User account."""

password_sha: str
password_hash: str
path: Path

@classmethod
Expand All @@ -49,24 +50,44 @@ def load(cls, path: Path) -> "UserAccount":
def new(cls, password: str, path: Path) -> "UserAccount":
"""Create a new user."""
user = UserAccount(
password_sha=sha256(string=password),
password_hash=argon2id(password=password),
path=path,
)
user.store()
return UserAccount.load(path=path)

def is_valid(self, password: str) -> bool:
"""Check if a password string is valid."""
return sha256(string=password) == self.password_sha
try:
ph = argon2.PasswordHasher()
valid = ph.verify(self.password_hash, password)

if valid and ph.check_needs_rehash(self.password_hash):
self.password_hash = argon2id(password)
self.store()

return valid
except argon2.exceptions.VerificationError:
return False
except argon2.exceptions.InvalidHashError:
# Verify legacy password hash and update it to Argon2id if valid
sha256 = hashlib.sha256()
sha256.update(password.encode())
if sha256.hexdigest() == self.password_hash:
self.password_hash = argon2id(password=password)
self.store()
return True

return False

def update(self, old_password: str, new_password: str) -> None:
"""Update current password."""
if not self.is_valid(password=old_password):
raise ValueError("Old password is not valid")
self.password_sha = sha256(string=new_password)
self.password_hash = argon2id(password=new_password)
self.store()

def force_update(self, new_password: str) -> None:
"""Force update current password."""
self.password_sha = sha256(string=new_password)
self.password_hash = argon2id(password=new_password)
self.store()
4 changes: 4 additions & 0 deletions operate/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@
from operate.account.user import UserAccount
from operate.constants import KEY, KEYS, OPERATE_HOME, SERVICES
from operate.ledger.profiles import DEFAULT_NEW_SAFE_FUNDS_AMOUNT
from operate.migration import MigrationManager
from operate.operate_types import Chain, DeploymentStatus, LedgerType
from operate.quickstart.analyse_logs import analyse_logs
from operate.quickstart.claim_staking_rewards import claim_staking_rewards
Expand Down Expand Up @@ -95,6 +96,9 @@ def __init__(
)
self.password: t.Optional[str] = os.environ.get("OPERATE_USER_PASSWORD")

mm = MigrationManager(self._path, self.logger)
mm.migrate_user_account()

def create_user_account(self, password: str) -> UserAccount:
"""Create a user account."""
self.password = password
Expand Down
60 changes: 60 additions & 0 deletions operate/migration.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# -*- coding: utf-8 -*-
# ------------------------------------------------------------------------------
#
# Copyright 2025 Valory AG
#
# 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.
#
# ------------------------------------------------------------------------------

"""Utilities for format migration"""


import json
import logging
from pathlib import Path


class MigrationManager:
"""MigrationManager"""

# TODO Backport here migration for services/config.json, etc.

def __init__(
self,
home: Path,
logger: logging.Logger,
) -> None:
"""Initialize object."""
super().__init__()
self._path = home
self.logger = logger

def migrate_user_account(self) -> None:
"""Migrates user.json"""

path = self._path / "user.json"
if not path.exists():
return

with open(path, "r", encoding="utf-8") as f:
data = json.load(f)

if "password_sha" not in data:
return

new_data = {"password_hash": data["password_sha"]}
with open(path, "w", encoding="utf-8") as f:
json.dump(new_data, f, indent=4)

self.logger.info("[MIGRATION MANAGER] Migrated user.json.")
Loading