blob: 2e384e35042d60ea696ba0e9bd4318e4f2f6ecb0 [file] [log] [blame]
/**
* Copyright 2017 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
**************************************************************************
*/
#import <Foundation/Foundation.h>
#import "TINKRegistryConfig.h"
NS_ASSUME_NONNULL_BEGIN
/**
* This class is used for registering with the Registry all instances of Aead key types supported in
* a particular release of Tink.
*
* To register all Aead key types provided in the latest release of Tink one can do:
*
* NSError *error = nil;
* TINKAeadConfig *aeadConfig = [[TINKAeadConfig alloc] initWithError:&error];
* if (!aeadConfig || error) {
* // handle error.
* }
*
* if (![TINKConfig registerConfig:aeadConfig error:&error]) {
* // handle error.
* }
*
* For more information on the creation and usage of TINKAead instances see TINKAeadFactory.
*/
@interface TINKAeadConfig : TINKRegistryConfig
/* Use -initWithError: to get an instance of TINKAeadConfig. */
- (instancetype)init NS_UNAVAILABLE;
/* Returns config of Aead implementations supported in the latest version of Tink. */
- (nullable instancetype)initWithError:(NSError **)error NS_SWIFT_NAME(init())
NS_DESIGNATED_INITIALIZER;
@end
NS_ASSUME_NONNULL_END