DITHTTPListenConfig
@interface DITHTTPListenConfig : NSObject <NSCopying, NSMutableCopying>
+ (instancetype)httpListenConfig;
@property (nonatomic, readonly, getter=isEnabled) BOOL enabled;
/**
IP interface to bind to. [::] by default.
*/
@property (nonatomic, readonly) NSString *interfaceIp;
/**
Listening port. 80 by default.
*/
@property (nonatomic, readonly) uint16_t port;
/**
An absolute path to a directory of static HTTP content that should be served by this device.
If nil (default), this feature is disabled.
*/
@property (nonatomic, readonly, nullable) NSString *staticContentPath;
/**
If YES (default), peers can connect over websocket to sync with this peer.
This feature has security implications and should only be used together with documentation on
Ditto's website.
*/
@property (nonatomic, readonly) BOOL websocketSync;
/**
An absolute path to the PEM-formatted private key for HTTPS. Must be set together with
tlsCertificatePath.
If nil, the server runs as unencrypted HTTP.
*/
@property (nonatomic, readonly, nullable) NSString *tlsKeyPath;
/**
An absolute path to the PEM-formatted certificate for HTTPS. Must be set together with tlsKeyPath.
If nil, the server runs as unencrypted HTTP.
*/
@property (nonatomic, readonly, nullable) NSString *tlsCertificatePath;
/**
Enable acting as a provider of Ditto identities.
*/
@property (nonatomic, readonly, getter=isIdentityProvider) BOOL identityProvider;
/**
PEM-encoded private key for signing tokens and certificates when acting as an identity provider.
*/
@property (nonatomic, readonly, nullable) NSString *identityProviderSigningKey;
/**
PEM-encoded public keys for verifying tokens and certificates when acting as an identity provider.
*/
@property (nonatomic, readonly, nullable) NSArray<NSString *> *identityProviderVerifyingKeys;
/**
PEM-encoded private key that should be used to issue certificates for clients in peer-to-peer mode.
*/
@property (nonatomic, readonly, nullable) NSString *caKey;
- (instancetype)initWithDITHTTPListenConfig:(DITHTTPListenConfig *)config;
- (instancetype)initWithEnabled:(BOOL)enabled
interfaceIp:(NSString *)interfaceIp
port:(uint16_t)port
staticContentPath:(nullable NSString *)staticContentPath
websocketSync:(BOOL)websocketSync
tlsKeyPath:(nullable NSString *)tlsKeyPath
tlsCertificatePath:(nullable NSString *)tlsCertificatePath
isIdentityProvider:(BOOL)isIdentityProvider
identityProviderSigningKey:(nullable NSString *)identityProviderSigningKey
identityProviderVerifyingKeys:(nullable NSArray<NSString *> *)identityProviderVerifyingKeys
caKey:(nullable NSString *)caKey;
- (BOOL)isEqualToDITHTTPListenConfig:(DITHTTPListenConfig *)config;
@end
Undocumented
-
Undocumented
Declaration
Objective-C
+ (instancetype)httpListenConfig;
-
Undocumented
Declaration
Objective-C
@property (nonatomic, readonly, getter=isEnabled) BOOL enabled
-
IP interface to bind to. [::] by default.
Declaration
Objective-C
@property (nonatomic, readonly) NSString *_Nonnull interfaceIp;
-
Listening port. 80 by default.
Declaration
Objective-C
@property (nonatomic, readonly) uint16_t port;
-
An absolute path to a directory of static HTTP content that should be served by this device.
If nil (default), this feature is disabled.
Declaration
Objective-C
@property (nonatomic, readonly, nullable) NSString *staticContentPath;
-
If YES (default), peers can connect over websocket to sync with this peer.
This feature has security implications and should only be used together with documentation on Ditto’s website.
Declaration
Objective-C
@property (nonatomic, readonly) BOOL websocketSync;
-
An absolute path to the PEM-formatted private key for HTTPS. Must be set together with tlsCertificatePath.
If nil, the server runs as unencrypted HTTP.
Declaration
Objective-C
@property (nonatomic, readonly, nullable) NSString *tlsKeyPath;
-
An absolute path to the PEM-formatted certificate for HTTPS. Must be set together with tlsKeyPath.
If nil, the server runs as unencrypted HTTP.
Declaration
Objective-C
@property (nonatomic, readonly, nullable) NSString *tlsCertificatePath;
-
Enable acting as a provider of Ditto identities.
Declaration
Objective-C
@property (nonatomic, readonly, getter=isIdentityProvider) BOOL identityProvider;
-
PEM-encoded private key for signing tokens and certificates when acting as an identity provider.
Declaration
Objective-C
@property (nonatomic, readonly, nullable) NSString *identityProviderSigningKey;
-
PEM-encoded public keys for verifying tokens and certificates when acting as an identity provider.
Declaration
Objective-C
@property (nonatomic, readonly, nullable) NSArray<NSString *> *identityProviderVerifyingKeys;
-
PEM-encoded private key that should be used to issue certificates for clients in peer-to-peer mode.
Declaration
Objective-C
@property (nonatomic, readonly, nullable) NSString *caKey;
-
Undocumented
Declaration
Objective-C
- (instancetype)initWithDITHTTPListenConfig:(DITHTTPListenConfig *)config;
-
-initWithEnabled:
interfaceIp: port: staticContentPath: websocketSync: tlsKeyPath: tlsCertificatePath: isIdentityProvider: identityProviderSigningKey: identityProviderVerifyingKeys: caKey: Undocumented
Declaration
Objective-C
- (instancetype)initWithEnabled:(BOOL)enabled interfaceIp:(NSString *)interfaceIp port:(uint16_t)port staticContentPath:(nullable NSString *)staticContentPath websocketSync:(BOOL)websocketSync tlsKeyPath:(nullable NSString *)tlsKeyPath tlsCertificatePath:(nullable NSString *)tlsCertificatePath isIdentityProvider:(BOOL)isIdentityProvider identityProviderSigningKey:(nullable NSString *)identityProviderSigningKey identityProviderVerifyingKeys:(nullable NSArray<NSString *> *)identityProviderVerifyingKeys caKey:(nullable NSString *)caKey;
-
Undocumented
Declaration
Objective-C
- (BOOL)isEqualToDITHTTPListenConfig:(DITHTTPListenConfig *)config;
-
Undocumented
Declaration
Objective-C
- (DITHTTPListenConfig *)copy;
-
Undocumented
Declaration
Objective-C
- (DITMutableHTTPListenConfig *)mutableCopy;