You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

40 lines
1.3 KiB

// PEPPassphraseCache.h
// pEpObjCAdapter
// Created by Dirk Zimmermann on 25.06.20.
// Copyright © 2020 p≡p. All rights reserved.
#import <Foundation/Foundation.h>
extern const NSUInteger PEPPassphraseCacheMaxNumberOfPassphrases;
/// Caches passwords the app sets after asking the user, for some time.
/// - Note: The passwords are expected to be Unicode Normalization Form C,
/// in order to meet the engine's requirement of being UTF-8 NFC strings.
@interface PEPPassphraseCache : NSObject
/// An optional passphrase that does not time out.
@property (nonatomic) NSString * _Nullable storedPassphrase;
/// Add a new passphrase that will be removed from the cache after some time.
- (void)addPassphrase:(NSString *)passphrase;
/// Retrieve the current list of cached passwords, including the empty one (`@""`),
/// in the order "last added (or successfully used) first"
/// (except the empty password, which is _always_ first).
- (NSArray<NSString *> *)passphrases;
/// Indicate that the given passphrase was just successfully used and its timeout
/// should be reset.
- (void)resetTimeoutForPassphrase:(NSString *)passphrase;
/// Get the (global) passphrase cache
+ (PEPPassphraseCache * _Nonnull)passphraseCache;