SophaxChat/Tor/TorFramework/TOROnionAuth.h

1//
2//  TOROnionAuth.h
3//  Tor
4//
5//  Created by Benjamin Erhart on 29.09.21.
6//
7
8#import <Foundation/Foundation.h>
9#import "TORAuthKey.h"
10
11NS_ASSUME_NONNULL_BEGIN
12
13/**
14 Support for Onion v3 service authentication configuration files.
15 */
16NS_SWIFT_NAME(TorOnionAuth)
17@interface TOROnionAuth : NSObject
18
19
20/**
21 The directory where this instance expects the private key files to be in.
22 */
23@property (nonatomic, nullable, readonly) NSURL *privateUrl;
24
25/**
26 The directory where this instance expects the public key files to be in.
27 */
28@property (nonatomic, nullable, readonly) NSURL *publicUrl;
29
30/**
31 The found public and/or private keys in the base \c directory.
32
33 @see -directory
34 */
35@property (nonatomic, nonnull, readonly) NSArray<TORAuthKey *> *keys;
36
37
38/**
39 Initialize with a given directory. Will immediately read all keys on disk.
40
41 If you have a lot of keys, you might want to do this in a background thread!
42
43 @param privateUrl  The base directory where the key files live.
44 Should be the same as you set in \c <ClientOnionAuthDir> for clients.
45
46 @param publicUrl  The base directory where the key files live.
47 Should be the same as you set in \c <HiddenServiceDir> for servers.
48
49 @see https://2019.www.torproject.org/docs/tor-manual.html.en#ClientOnionAuthDir
50
51 @see https://2019.www.torproject.org/docs/tor-manual.html.en#HiddenServiceDir
52
53 @see https://2019.www.torproject.org/docs/tor-manual.html.en#_client_authorization
54 */
55- (instancetype)initWithPrivateDirUrl:(nullable NSURL *)privateUrl andPublicDirUrl:(nullable NSURL *)publicUrl NS_SWIFT_NAME(init(withPrivateDir:andPublicDir:));
56
57/**
58 Initialize with a given directory. Will immediately read all keys on disk.
59
60 If you have a lot of keys, you might want to do this in a background thread!
61
62 @param privatePath  The base directory where the key files live.
63 Should be the same as you set in \c <ClientOnionAuthDir> for clients.
64
65 @param publicPath  The base directory where the key files live.
66 Should be the same as you set in \c <HiddenServiceDir> for servers.
67
68 @see https://2019.www.torproject.org/docs/tor-manual.html.en#ClientOnionAuthDir
69
70 @see https://2019.www.torproject.org/docs/tor-manual.html.en#HiddenServiceDir
71
72 @see https://2019.www.torproject.org/docs/tor-manual.html.en#_client_authorization
73 */
74- (instancetype)initWithPrivateDir:(NSString *)privatePath andPublicDir:(NSString *)publicPath NS_SWIFT_NAME(init(withPrivateDir:andPublicDir:));
75
76
77/**
78 Add an authentication key (public or private) to the configuration.
79
80 If a key with the same file name already exists, it will be overwritten. If not, it will be added at the end of the
81 \c keys array.
82
83 @param key A new or modified key.
84
85 @returns \c YES on success, \c NO on failure.
86*/
87- (BOOL)set:(TORAuthKey *)key;
88
89/**
90 Remove the key at the specified index.
91
92 @param idx The index of the key in \c keys.
93
94 @returns \c YES on success, \c NO on failure.
95 */
96- (BOOL)removeKeyAtIndex:(NSInteger)idx;
97
98
99@end
100
101NS_ASSUME_NONNULL_END