SophaxChat/Tor/TorFramework/TORNode.h

1//
2//  TORNode.h
3//  Tor
4//
5//  Created by Benjamin Erhart on 09.12.19.
6//
7
8#import <Foundation/Foundation.h>
9
10NS_ASSUME_NONNULL_BEGIN
11
12NS_SWIFT_NAME(TorNode)
13@interface TORNode : NSObject<NSSecureCoding>
14
15/**
16Regular expression to identify and extract a valid IPv4 address.
17
18Taken from https://nbviewer.jupyter.org/github/rasbt/python_reference/blob/master/tutorials/useful_regex.ipynb
19*/
20@property (class, nonatomic, readonly) NSRegularExpression *ipv4Regex;
21
22/**
23Regular expression to identify and extract a valid IPv6 address.
24
25Taken from https://nbviewer.jupyter.org/github/rasbt/python_reference/blob/master/tutorials/useful_regex.ipynb
26*/
27@property (class, nonatomic, readonly) NSRegularExpression *ipv6Regex;
28
29/**
30 The fingerprint aka. ID of a Tor node.
31 */
32@property (nonatomic, nullable) NSString *fingerprint;
33
34/**
35 The nickname of a Tor node.
36 */
37@property (nonatomic, nullable) NSString *nickName;
38
39/**
40 The IPv4 address of a Tor node.
41 */
42@property (nonatomic, nullable) NSString *ipv4Address;
43
44/**
45 The IPv6 address of a Tor node.
46 */
47@property (nonatomic, nullable) NSString *ipv6Address;
48
49/**
50 The country code of a Tor node's country.
51 */
52@property (nonatomic, nullable) NSString *countryCode;
53
54/**
55 The localized country name of a Tor node's country.
56 */
57@property (nonatomic, readonly, nullable) NSString *localizedCountryName;
58
59/**
60 If this node can act as an exit node or not.
61 */
62@property BOOL isExit;
63
64/**
65 Create a `TORNode` object from a "LongName" node string which should contain the fingerprint and the nickname.
66
67 See https://torproject.gitlab.io/torspec/control-spec.html#general-use-tokens
68
69 @param longName A "LongName" identifying a Tor node.
70 */
71- (instancetype)initFromString:(NSString *)longName;
72
73/**
74 Creates a list of `TORNode` objects from the response of a `ns/[*]` call which should contain the nickname and IP address(es).
75
76 See https://torproject.gitlab.io/torspec/control-spec.html#getinfo
77
78 @param nsString Response from `ns/[*]` call, identifying one or more Tor nodes.
79 @return a list of `TORNode`s discovered in the given string. Might be empty.
80 */
81+ (NSArray<TORNode *>  * _Nonnull)parseFromNsString:(NSString * _Nullable)nsString exitOnly:(BOOL)exitOnly;
82
83
84/**
85 Acquires IPv4 and IPv6 addresses from the given string.
86
87 See https://torproject.gitlab.io/torspec/control-spec.html#getinfo
88
89 @param response Should be the response of a `ns/id/<fingerprint>` call.
90 */
91- (void)acquireIpAddressesFromNsResponse:(NSString *)response;
92
93@end
94
95NS_ASSUME_NONNULL_END