mirror of
https://github.com/twonlyapp/twonly-app.git
synced 2026-09-01 08:54:08 +00:00
update comments
Some checks are pending
Flutter analyze & test / flutter_analyze_and_test (push) Waiting to run
Some checks are pending
Flutter analyze & test / flutter_analyze_and_test (push) Waiting to run
This commit is contained in:
parent
060f90ff6b
commit
95054068f7
3 changed files with 26 additions and 120 deletions
|
|
@ -17,80 +17,8 @@ import 'package:protobuf/protobuf.dart' as $pb;
|
|||
|
||||
export 'package:protobuf/protobuf.dart' show GeneratedMessageGenericExtensions;
|
||||
|
||||
/// Send from the person who tries to recover their account.
|
||||
/// This can be done via a link, which will then be opend in the app of the contact.
|
||||
/// The contact than has to manualy select from which user he got the request.
|
||||
/// -> Using this phishing is harder, as the user has to manualy select the user to recovery
|
||||
/// -> The user who wants to recover his account does not need to remember her old username
|
||||
class RecoveryRequest extends $pb.GeneratedMessage {
|
||||
factory RecoveryRequest({
|
||||
$core.String? notificationId,
|
||||
$core.List<$core.int>? publicKey,
|
||||
}) {
|
||||
final result = create();
|
||||
if (notificationId != null) result.notificationId = notificationId;
|
||||
if (publicKey != null) result.publicKey = publicKey;
|
||||
return result;
|
||||
}
|
||||
|
||||
RecoveryRequest._();
|
||||
|
||||
factory RecoveryRequest.fromBuffer($core.List<$core.int> data,
|
||||
[$pb.ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY]) =>
|
||||
create()..mergeFromBuffer(data, registry);
|
||||
factory RecoveryRequest.fromJson($core.String json,
|
||||
[$pb.ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY]) =>
|
||||
create()..mergeFromJson(json, registry);
|
||||
|
||||
static final $pb.BuilderInfo _i = $pb.BuilderInfo(
|
||||
_omitMessageNames ? '' : 'RecoveryRequest',
|
||||
package: const $pb.PackageName(
|
||||
_omitMessageNames ? '' : 'passwordless_recovery'),
|
||||
createEmptyInstance: create)
|
||||
..aOS(1, _omitFieldNames ? '' : 'notificationId')
|
||||
..a<$core.List<$core.int>>(
|
||||
2, _omitFieldNames ? '' : 'publicKey', $pb.PbFieldType.OY)
|
||||
..hasRequiredFields = false;
|
||||
|
||||
@$core.Deprecated('See https://github.com/google/protobuf.dart/issues/998.')
|
||||
RecoveryRequest clone() => deepCopy();
|
||||
@$core.Deprecated('See https://github.com/google/protobuf.dart/issues/998.')
|
||||
RecoveryRequest copyWith(void Function(RecoveryRequest) updates) =>
|
||||
super.copyWith((message) => updates(message as RecoveryRequest))
|
||||
as RecoveryRequest;
|
||||
|
||||
@$core.override
|
||||
$pb.BuilderInfo get info_ => _i;
|
||||
|
||||
@$core.pragma('dart2js:noInline')
|
||||
static RecoveryRequest create() => RecoveryRequest._();
|
||||
@$core.override
|
||||
RecoveryRequest createEmptyInstance() => create();
|
||||
@$core.pragma('dart2js:noInline')
|
||||
static RecoveryRequest getDefault() => _defaultInstance ??=
|
||||
$pb.GeneratedMessage.$_defaultFor<RecoveryRequest>(create);
|
||||
static RecoveryRequest? _defaultInstance;
|
||||
|
||||
@$pb.TagNumber(1)
|
||||
$core.String get notificationId => $_getSZ(0);
|
||||
@$pb.TagNumber(1)
|
||||
set notificationId($core.String value) => $_setString(0, value);
|
||||
@$pb.TagNumber(1)
|
||||
$core.bool hasNotificationId() => $_has(0);
|
||||
@$pb.TagNumber(1)
|
||||
void clearNotificationId() => $_clearField(1);
|
||||
|
||||
@$pb.TagNumber(2)
|
||||
$core.List<$core.int> get publicKey => $_getN(1);
|
||||
@$pb.TagNumber(2)
|
||||
set publicKey($core.List<$core.int> value) => $_setBytes(1, value);
|
||||
@$pb.TagNumber(2)
|
||||
$core.bool hasPublicKey() => $_has(1);
|
||||
@$pb.TagNumber(2)
|
||||
void clearPublicKey() => $_clearField(2);
|
||||
}
|
||||
|
||||
/// Used as envelope for TrustedFriendShare and RecoveryData
|
||||
/// Used as envelope for TrustedFriendShare and RecoveryData.
|
||||
/// Encrypted using XChaCha20-Poly1305.
|
||||
class EncryptedEnvelope extends $pb.GeneratedMessage {
|
||||
factory EncryptedEnvelope({
|
||||
$core.List<$core.int>? encryptedData,
|
||||
|
|
@ -254,8 +182,8 @@ class TrustedFriendShare_User extends $pb.GeneratedMessage {
|
|||
void clearAvatar() => $_clearField(3);
|
||||
}
|
||||
|
||||
/// Send from the trusted friend to
|
||||
/// This is encrypted with the received public key.
|
||||
/// Sent from the trusted friend to the recovering user via the server.
|
||||
/// This is symmetrically encrypted using the encryption key received from the recovery link.
|
||||
class TrustedFriendShare extends $pb.GeneratedMessage {
|
||||
factory TrustedFriendShare({
|
||||
TrustedFriendShare_User? trustedFriend,
|
||||
|
|
@ -313,7 +241,7 @@ class TrustedFriendShare extends $pb.GeneratedMessage {
|
|||
$pb.GeneratedMessage.$_defaultFor<TrustedFriendShare>(create);
|
||||
static TrustedFriendShare? _defaultInstance;
|
||||
|
||||
/// This allows to display the user which user has send him his recovery data.
|
||||
/// This allows to display to the recovering user which trusted friend has sent their recovery data.
|
||||
@$pb.TagNumber(1)
|
||||
TrustedFriendShare_User get trustedFriend => $_getN(0);
|
||||
@$pb.TagNumber(1)
|
||||
|
|
@ -325,7 +253,7 @@ class TrustedFriendShare extends $pb.GeneratedMessage {
|
|||
@$pb.TagNumber(1)
|
||||
TrustedFriendShare_User ensureTrustedFriend() => $_ensure(0);
|
||||
|
||||
/// This allows to display the userdata, showing that he is recovering the correct person.
|
||||
/// This allows to display the userdata, showing that the trusted friend is recovering the correct person.
|
||||
@$pb.TagNumber(2)
|
||||
TrustedFriendShare_User get shareUser => $_getN(1);
|
||||
@$pb.TagNumber(2)
|
||||
|
|
@ -337,7 +265,7 @@ class TrustedFriendShare extends $pb.GeneratedMessage {
|
|||
@$pb.TagNumber(2)
|
||||
TrustedFriendShare_User ensureShareUser() => $_ensure(1);
|
||||
|
||||
/// The minimum threshold required to decrypte the shares.
|
||||
/// The minimum threshold required to reconstruct the shares.
|
||||
@$pb.TagNumber(3)
|
||||
$core.int get threshold => $_getIZ(2);
|
||||
@$pb.TagNumber(3)
|
||||
|
|
@ -347,7 +275,7 @@ class TrustedFriendShare extends $pb.GeneratedMessage {
|
|||
@$pb.TagNumber(3)
|
||||
void clearThreshold() => $_clearField(3);
|
||||
|
||||
/// The actual share which will become: SharedSecretData
|
||||
/// The actual share which will be used to reconstruct SharedSecretData.
|
||||
@$pb.TagNumber(4)
|
||||
$core.List<$core.int> get sharedSecretData => $_getN(3);
|
||||
@$pb.TagNumber(4)
|
||||
|
|
@ -427,7 +355,7 @@ class RecoveryData extends $pb.GeneratedMessage {
|
|||
void clearKeyManager() => $_clearField(3);
|
||||
}
|
||||
|
||||
/// After received all shares this is decrypted by the user restoring its own
|
||||
/// After receiving threshold shares, this is reconstructed by the recovering user.
|
||||
class SharedSecretData extends $pb.GeneratedMessage {
|
||||
factory SharedSecretData({
|
||||
$core.List<$core.int>? recoveryData,
|
||||
|
|
@ -486,7 +414,7 @@ class SharedSecretData extends $pb.GeneratedMessage {
|
|||
$pb.GeneratedMessage.$_defaultFor<SharedSecretData>(create);
|
||||
static SharedSecretData? _defaultInstance;
|
||||
|
||||
/// The recovery data is encrypted in case a second factor was chosen.
|
||||
/// The recovery data (RecoveryData). It is encrypted with the server_key in case a second factor was chosen.
|
||||
@$pb.TagNumber(1)
|
||||
$core.List<$core.int> get recoveryData => $_getN(0);
|
||||
@$pb.TagNumber(1)
|
||||
|
|
@ -496,6 +424,8 @@ class SharedSecretData extends $pb.GeneratedMessage {
|
|||
@$pb.TagNumber(1)
|
||||
void clearRecoveryData() => $_clearField(1);
|
||||
|
||||
/// Combined with the user's PIN/Email via HKDF to derive the key to decrypt the encrypted server_key.
|
||||
/// The server NEVER sees this value.
|
||||
@$pb.TagNumber(3)
|
||||
$core.List<$core.int> get serverKeyProtection => $_getN(1);
|
||||
@$pb.TagNumber(3)
|
||||
|
|
@ -505,6 +435,7 @@ class SharedSecretData extends $pb.GeneratedMessage {
|
|||
@$pb.TagNumber(3)
|
||||
void clearServerKeyProtection() => $_clearField(3);
|
||||
|
||||
/// Used to authenticate with the server to fetch the encrypted server_key.
|
||||
@$pb.TagNumber(5)
|
||||
$core.List<$core.int> get pinUnlockToken => $_getN(2);
|
||||
@$pb.TagNumber(5)
|
||||
|
|
|
|||
|
|
@ -15,20 +15,6 @@ import 'dart:convert' as $convert;
|
|||
import 'dart:core' as $core;
|
||||
import 'dart:typed_data' as $typed_data;
|
||||
|
||||
@$core.Deprecated('Use recoveryRequestDescriptor instead')
|
||||
const RecoveryRequest$json = {
|
||||
'1': 'RecoveryRequest',
|
||||
'2': [
|
||||
{'1': 'notification_id', '3': 1, '4': 1, '5': 9, '10': 'notificationId'},
|
||||
{'1': 'public_key', '3': 2, '4': 1, '5': 12, '10': 'publicKey'},
|
||||
],
|
||||
};
|
||||
|
||||
/// Descriptor for `RecoveryRequest`. Decode as a `google.protobuf.DescriptorProto`.
|
||||
final $typed_data.Uint8List recoveryRequestDescriptor = $convert.base64Decode(
|
||||
'Cg9SZWNvdmVyeVJlcXVlc3QSJwoPbm90aWZpY2F0aW9uX2lkGAEgASgJUg5ub3RpZmljYXRpb2'
|
||||
'5JZBIdCgpwdWJsaWNfa2V5GAIgASgMUglwdWJsaWNLZXk=');
|
||||
|
||||
@$core.Deprecated('Use encryptedEnvelopeDescriptor instead')
|
||||
const EncryptedEnvelope$json = {
|
||||
'1': 'EncryptedEnvelope',
|
||||
|
|
|
|||
|
|
@ -1,42 +1,28 @@
|
|||
syntax = "proto3";
|
||||
package passwordless_recovery;
|
||||
|
||||
// Recovery Process
|
||||
// - Generating: TempID and a new assymetric key pair
|
||||
// - Uploading to the server TempID + Push Tokens so the server can notify the user that someone helped him
|
||||
|
||||
|
||||
// Send from the person who tries to recover their account.
|
||||
// This can be done via a link, which will then be opend in the app of the contact.
|
||||
// The contact than has to manualy select from which user he got the request.
|
||||
// -> Using this phishing is harder, as the user has to manualy select the user to recovery
|
||||
// -> The user who wants to recover his account does not need to remember her old username
|
||||
message RecoveryRequest {
|
||||
string notification_id = 1;
|
||||
bytes public_key = 2;
|
||||
}
|
||||
|
||||
// Used as envelope for TrustedFriendShare and RecoveryData
|
||||
// Used as envelope for TrustedFriendShare and RecoveryData.
|
||||
// Encrypted using XChaCha20-Poly1305.
|
||||
message EncryptedEnvelope {
|
||||
bytes encrypted_data = 1;
|
||||
bytes iv = 2;
|
||||
bytes mac = 3;
|
||||
}
|
||||
|
||||
// Send from the trusted friend to
|
||||
// This is encrypted with the received public key.
|
||||
// Sent from the trusted friend to the recovering user via the server.
|
||||
// This is symmetrically encrypted using the encryption key received from the recovery link.
|
||||
message TrustedFriendShare {
|
||||
|
||||
// This allows to display the user which user has send him his recovery data.
|
||||
// This allows to display to the recovering user which trusted friend has sent their recovery data.
|
||||
User trusted_friend = 1;
|
||||
|
||||
// This allows to display the userdata, showing that he is recovering the correct person.
|
||||
// This allows to display the userdata, showing that the trusted friend is recovering the correct person.
|
||||
User share_user = 2;
|
||||
|
||||
// The minimum threshold required to decrypte the shares.
|
||||
// The minimum threshold required to reconstruct the shares.
|
||||
int32 threshold = 3;
|
||||
|
||||
// The actual share which will become: SharedSecretData
|
||||
// The actual share which will be used to reconstruct SharedSecretData.
|
||||
bytes shared_secret_data = 4;
|
||||
|
||||
message User {
|
||||
|
|
@ -52,14 +38,17 @@ message RecoveryData {
|
|||
bytes key_manager = 3;
|
||||
}
|
||||
|
||||
// After received all shares this is decrypted by the user restoring its own
|
||||
// After receiving threshold shares, this is reconstructed by the recovering user.
|
||||
message SharedSecretData {
|
||||
|
||||
// The recovery data is encrypted in case a second factor was chosen.
|
||||
// The recovery data (RecoveryData). It is encrypted with the server_key in case a second factor was chosen.
|
||||
bytes recovery_data = 1;
|
||||
|
||||
// Combined with the user's PIN/Email via HKDF to derive the key to decrypt the encrypted server_key.
|
||||
// The server NEVER sees this value.
|
||||
optional bytes server_key_protection = 3;
|
||||
|
||||
// Used to authenticate with the server to fetch the encrypted server_key.
|
||||
optional bytes pin_unlock_token = 5;
|
||||
|
||||
optional string email_hint = 6;
|
||||
|
|
|
|||
Loading…
Reference in a new issue