OIDAuthorizationRequest.h

Go to the documentation of this file.

 
#import <Foundation/Foundation.h>
 
// These files only declare string constants useful for constructing a @c OIDAuthorizationRequest,
// so they are imported here for convenience.
#import "OIDExternalUserAgentRequest.h"
#import "OIDResponseTypes.h"
#import "OIDScopes.h"
 
@class OIDServiceConfiguration;
 
NS_ASSUME_NONNULL_BEGIN
 
extern NSString *const OIDOAuthorizationRequestCodeChallengeMethodS256;
 
 
@interface OIDAuthorizationRequest :
    NSObject<NSCopying, NSSecureCoding, OIDExternalUserAgentRequest>
 
@property(nonatomic, readonly) OIDServiceConfiguration *configuration;
 
@property(nonatomic, readonly) NSString *responseType;
 
@property(nonatomic, readonly) NSString *clientID;
 
@property(nonatomic, readonly, nullable) NSString *clientSecret;
 
@property(nonatomic, readonly, nullable) NSString *scope;
 
@property(nonatomic, readonly, nullable) NSURL *redirectURL;
 
@property(nonatomic, readonly, nullable) NSString *state;
 
@property(nonatomic, readonly, nullable) NSString *nonce;
 
@property(nonatomic, readonly, nullable) NSString *codeVerifier;
 
@property(nonatomic, readonly, nullable) NSString *codeChallenge;
 
@property(nonatomic, readonly, nullable) NSString *codeChallengeMethod;
 
@property(nonatomic, readonly, nullable) NSDictionary<NSString *, NSString *> *additionalParameters;
 
- (instancetype)init NS_UNAVAILABLE;
 
- (instancetype)
    initWithConfiguration:(OIDServiceConfiguration *)configuration
                 clientId:(NSString *)clientID
                   scopes:(nullable NSArray<NSString *> *)scopes
              redirectURL:(NSURL *)redirectURL
             responseType:(NSString *)responseType
     additionalParameters:(nullable NSDictionary<NSString *, NSString *> *)additionalParameters;
 
- (instancetype)
    initWithConfiguration:(OIDServiceConfiguration *)configuration
                 clientId:(NSString *)clientID
             clientSecret:(nullable NSString *)clientSecret
                   scopes:(nullable NSArray<NSString *> *)scopes
              redirectURL:(NSURL *)redirectURL
             responseType:(NSString *)responseType
     additionalParameters:(nullable NSDictionary<NSString *, NSString *> *)additionalParameters;
 
- (instancetype)
    initWithConfiguration:(OIDServiceConfiguration *)configuration
                 clientId:(NSString *)clientID
             clientSecret:(nullable NSString *)clientSecret
                    scope:(nullable NSString *)scope
              redirectURL:(nullable NSURL *)redirectURL
             responseType:(NSString *)responseType
                    state:(nullable NSString *)state
                    nonce:(nullable NSString *)nonce
             codeVerifier:(nullable NSString *)codeVerifier
            codeChallenge:(nullable NSString *)codeChallenge
      codeChallengeMethod:(nullable NSString *)codeChallengeMethod
     additionalParameters:(nullable NSDictionary<NSString *, NSString *> *)additionalParameters
    NS_DESIGNATED_INITIALIZER;
 
- (NSURL *)authorizationRequestURL;
 
+ (nullable NSString *)generateState;
 
+ (nullable NSString *)generateCodeVerifier;
 
+ (nullable NSString *)codeChallengeS256ForVerifier:(nullable NSString *)codeVerifier;
 
@end
 
NS_ASSUME_NONNULL_END