OFTLSStream.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008-2026 Jonathan Schleifer <js@nil.im>
 *
 * All rights reserved.
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License version 3.0 only,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
 * version 3.0 for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3.0 along with this program. If not, see
 * <https://www.gnu.org/licenses/>.
 */
 
#import "OFStream.h"
#import "OFRunLoop.h"
#import "OFX509Certificate.h"
 
OF_ASSUME_NONNULL_BEGIN

 
@class OFArray OF_GENERIC(ObjectType);
@class OFTLSStream;

typedef enum {
    OFTLSStreamErrorCodeUnknown,
    OFTLSStreamErrorCodeInitializationFailed,
    OFTLSStreamErrorCodeCertificateVerificationFailed,
    OFTLSStreamErrorCodeCertificateIssuerUntrusted,
    OFTLSStreamErrorCodeCertificateNameMismatch,
    OFTLSStreamErrorCodeCertificatedExpired,
    OFTLSStreamErrorCodeCertificateRevoked
} OFTLSStreamErrorCode;

@protocol OFTLSStreamDelegate <OFStreamDelegate>
@optional
-              (void)stream: (OFTLSStream *)stream
  didPerformClientHandshakeWithHost: (OFString *)host
              exception: (nullable id)exception;

- (void)streamDidPerformServerHandshake: (OFTLSStream *)stream
                  exception: (nullable id)exception;
@end

@interface OFTLSStream: OFStream <OFReadyForReadingObserving,
    OFReadyForWritingObserving>
{
    OFStream <OFReadyForReadingObserving, OFReadyForWritingObserving>
        *_underlyingStream;
    bool _verifiesCertificates;
    OFArray OF_GENERIC(OFX509Certificate *) *_Nullable _certificateChain;
    uintptr_t _atEndOfStream;   /* Change type on ABI bump */
    OF_RESERVE_IVARS(OFTLSStream, 2)
}

@property (readonly, nonatomic) OFStream <OFReadyForReadingObserving,
    OFReadyForWritingObserving> *underlyingStream;

@property OF_NULLABLE_PROPERTY (assign, nonatomic)
    id <OFTLSStreamDelegate> delegate;

@property (nonatomic) bool verifiesCertificates;

@property OF_NULLABLE_PROPERTY (copy, nonatomic)
    OFArray OF_GENERIC(OFX509Certificate *) *certificateChain;
 
- (instancetype)init OF_UNAVAILABLE;

+ (instancetype)streamWithStream: (OFStream <OFReadyForReadingObserving,
                      OFReadyForWritingObserving> *)stream;

- (instancetype)initWithStream: (OFStream <OFReadyForReadingObserving,
                    OFReadyForWritingObserving> *)stream
    OF_DESIGNATED_INITIALIZER;

- (void)asyncPerformClientHandshakeWithHost: (OFString *)host;

- (void)asyncPerformClientHandshakeWithHost: (OFString *)host
                runLoopMode: (OFRunLoopMode)runLoopMode;

- (void)performClientHandshakeWithHost: (OFString *)host;

- (void)asyncPerformServerHandshake;

- (void)asyncPerformServerHandshakeWithRunLoopMode: (OFRunLoopMode)runLoopMode;

- (void)performServerHandshake;
@end
 
#ifdef __cplusplus
extern "C" {
#endif
extern Class OFTLSStreamImplementation;

extern OFString *OFTLSStreamErrorCodeDescription(
    OFTLSStreamErrorCode errorCode);
#ifdef __cplusplus
}
#endif
 
OF_ASSUME_NONNULL_END