Updates made to SSYKeychainClass. Most significantly, I changed the parameter name class: to clase: in several methods. Also, in SSYKeychainQuery I deleted an unused accessor pair which was using a deprecated method.

Author: jerrykrinock

SSYKeychain.h

@@ -26,18 +26,28 @@ extern NSString *const kSSYKeychainErrorDomain;
  this class and replaced it with Sam's approach, based on his SSKeychainQuery,
  which uses only a few, modern SecKeychainXxxxx functions.
  
- Sam's SSKeychain is hard-wired to only support "generic" class keychain items.
+ Sam's SSKeychain is hard-wired to only support "generic" clase keychain items.
  In this fork of SSKeychainQuery, I have
  
- • Added support for other classes of keychain items, Internet in particular.
+ • Added support for other clases of keychain items, Internet in particular.
  • Made friendly to manual reference counting targets by adopting the NO_ARC
  compiler directive
  • Added more documentation, particularly to fill some holes in Apple's
  documentation.  That documetation follows here:
  
- Item Classes
+ Item Clases
  
- Item classes are defined by Apple as one of the strings enumerated in
+ I mean "Item Classes", however I found that when I used `class:` as a
+ parameter in an Objective-C method, Xcode 12 highlights 'class' as though
+ it were an Objective-C keyword, and gives me warnings when processing
+ header documentation that 'class' is not one of the parameters in the
+ function, even after I fix them.  After fighting with it and losing for about
+ 20 minutes, I decided to change all references to this type of thing to the
+ Spanish word 'clase' or its plural 'clases'.  This is actually better, I
+ think, because as you will read below, 'clase' is not, as one might first
+ think, a class in the Objective-C or Swift sense.
+ 
+ Item clases are defined by Apple as one of the strings enumerated in
  SetItem.h > kSecClass.  At this time (10.10), you can see there are five
  types listed (lines 60-64).  This corresponds roughly to the "Kind" column in
  the Keychain Access app.  Most items, including those whose "Kind" is one of
@@ -57,7 +67,7 @@ extern NSString *const kSSYKeychainErrorDomain;
  
  are in fact kSecClassInternetPassword.
  
- All queries require a class.  Passing itemClass = nil causes a default value,
+ All queries require a clase.  Passing itemClase = nil causes a default value,
  kSecClassGenericPassword, to be used.
  
  User's Keychain
@@ -74,25 +84,25 @@ extern NSString *const kSSYKeychainErrorDomain;
  
  Name: Service vs. Host
  
- Keychain items of the Internet class (kSecClassInternetPassword) have a host
+ Keychain items of the Internet clase (kSecClassInternetPassword) have a host
  name, but not a service name.  In contrast, keychain
- items of the generic class (kSecClassGenericPassword) have a service name, but
+ items of the generic clase (kSecClassGenericPassword) have a service name, but
  not a host name.  A host name is, of course, for example google.com for
  example.  A service name may be any arbitrary string created by the app which
  stored it in the keychain, for its own purposes.
  
  The Keychain Access app appears to take advantage of the fact that one is
  nil by having only one column, 'Name", and using it for whichever is not nil,
- depending on the class.  We do the same thing, with our 'servostName' 
- parameter, which we interpret to be a host name when an item of Internet class
+ depending on the clase.  We do the same thing, with our 'servostName'
+ parameter, which we interpret to be a host name when an item of Internet clase
  has been specified, and a service name otherwise.
  
  Item Attributes
  
  Item Attributes means a dictionary containing the attributes of a keychain
  item.  The keys in such a dictionary will be from the list of several dozen
  given in Apple's Keychain Services Reference > Attribute Item Keys, except that
- you may get a key "class", which I think is supposed to be "kcls", symbolized
+ you may get a key "clase/class", which I think is supposed to be "kcls", symbolized
  by kSecAttrKeyClass, and I think this is a bug in Keychain Services.
  
  For convenience in debugging, the Attribute Item Keys in macOS 10.10.2 have
@@ -160,7 +170,7 @@ extern NSString *const kSSYKeychainErrorDomain;
 
 /*!
  @brief    Returns a string containing the password for a given service name,
- account name, and item class, or `nil` if the Keychain doesn't have a password
+ account name, and item clase, or `nil` if the Keychain doesn't have a password
  for the given parameters.
  
  @details  See "Name: Service vs. Host" in the class documentatotion.
@@ -169,56 +179,56 @@ extern NSString *const kSSYKeychainErrorDomain;
  
  @param    trySubhosts  An array of strings, each of which are possible
  subdomains which will be prepended to the host with a "." when searching for
- an internet password (class=kSecClassInternetPassword.  Ignored if class =
+ an internet password (clase=kSecClassInternetPassword.  Ignored if clase =
  kSecClassGenericPassword.  For example, if you pass servost="google.com" and
  trySubhosts=@[@"www", @"my"], there will be three hosts searched: google.com,
  www.google.com and my.google.com.  Recommended subdomains are subdomains are
  "www", "my", "login", "mobile", "account".  If nil, searches only the given
  servost.
 
- @param   class  The class of the target keychain item, any of the constant
+ @param   clase  The clase of the target keychain item, any of the constant
  strings enumerated under SetItem.h > kSecClass.  If you pass nil, defaults to
  kSecClassGenericPassword.
  */
 + (NSString*)passwordForServost:(NSString*)servostName
                     trySubhosts:(NSArray*)trySubhosts
                         account:(NSString*)account
-                          class:(NSString*)itemClass
+                          clase:(NSString*)itemClase
                         error_p:(NSError*__autoreleasing*)error_p ;
 
 /*!
  @brief    Deletes from the user's keychain any item matching a given
- service name, account name and item class
+ service name, account name and item clase
  
  @details  See "Name: Service vs. Host" in the class documentatotion.  This
- parameter is  interpreted to specify a host name when the 'class' parameter is
+ parameter is  interpreted to specify a host name when the 'clase' parameter is
  kSecClassInternetPassword, and a service name otherwise.
  
  A better name for this method might be deleteItemForServost…, since actually
  it deletes a keychain *item*.  But since the nearby methods use 'password', and
  since it is useless or maybe impossible to have a keychain item without a
  password, I use 'password'.
  
- @param    class  See "Item Class" in the class documentation.  There is no wild
- card.  If you pass nil here, the class kSecClassGenericPassword is assumed.
+ @param    clase  See "Item Clase" in the class documentation.  There is no wild
+ card.  If you pass nil here, the clase kSecClassGenericPassword is assumed.
  
  @result  YES if successful, otherwise NO
  */
 + (BOOL)deletePasswordForServost:(NSString*)servostName
                          account:(NSString*)account
-                           class:(NSString*)itemClass
+                           clase:(NSString*)itemClase
                          error_p:(NSError*__autoreleasing*)error_p ;
 
 /*!
  @brief    Sets a password in the Keychain for a given service name, account
- name and item class
+ name and item clase
  
  @details  See "Name: Service vs. Host" in the class documentatotion.  This
- parameter is  interpreted to specify a host name when the 'class' parameter is
+ parameter is  interpreted to specify a host name when the 'clase' parameter is
  kSecClassInternetPassword, and a service name otherwise.
  
- @param    class  See "Item Class" in the class documentation.  There is no wild
- card.  If you pass nil here, the class kSecClassGenericPassword is assumed.
+ @param    clase  See "Item Clase" in the class documentation.  There is no wild
+ card.  If you pass nil here, the clase kSecClassGenericPassword is assumed.
  If the class is kSecClassGenericPassword, it will show up in the Keychain
  Access app with kind = "application password"
  
@@ -227,26 +237,26 @@ extern NSString *const kSSYKeychainErrorDomain;
 + (BOOL)setPassword:(NSString*)password
          forServost:(NSString*)servostName
             account:(NSString*)account
-              class:(NSString*)itemClass
+              clase:(NSString*)itemClase
             error_p:(NSError*__autoreleasing*)error_p ;
 
 /*!
  @brief    Returns attributes of all items in the user's keychain, of a given
- single class
+ single clase
  
  @details  See "Name: Service vs. Host" in the class documentatotion.
  
- @param    class  See "Item Class" in the class documentation.  There is no wild
- card.  If you pass nil here, the class kSecClassGenericPassword is assumed.
+ @param    clase  See "Item Clase" in the class documentation.  There is no wild
+ card.  If you pass nil here, the clase kSecClassGenericPassword is assumed.
  
  @result    An array, in unspecified order, of Item Attributes, one for each
  item found, or nil if no items were found to match the given specifications.
  See "Item Attributes" in the class documentation for more information.
  */
-+ (NSArray*)allItemsOfClass:(NSString*)itemClass ;
++ (NSArray*)allItemsOfClase:(NSString*)itemClase ;
 
 /*!
- @brief    Returns attributes of all Internet class (kSecClassInternetPassword)
+ @brief    Returns attributes of all Internet clase (kSecClassInternetPassword)
  items in the user's keychain
  
  @param  hostName  A name which appears in the "Name" column of the Keychain
@@ -259,7 +269,7 @@ extern NSString *const kSSYKeychainErrorDomain;
 + (NSArray*)allInternetItemsForHost:(NSString*)hostName ;
 
 /*!
- @brief    Returns attributes of all generic class (kSecClassGenericPassword)
+ @brief    Returns attributes of all generic clase (kSecClassGenericPassword)
  items in the user's keychain
  
  @param  serviceName  A name which appears in the "Name" column of the Keychain
@@ -273,7 +283,7 @@ extern NSString *const kSSYKeychainErrorDomain;
 
 /*!
  @brief    Returns the array of keychain items which have internet passwords in
- the user's keychain for a given class and service or host
+ the user's keychain for a given clase and service or host
  
  @param    trySubhosts  An array of strings, each of which are possible
  subdomains which will be prepended to the host with a "." when searching for
@@ -286,7 +296,7 @@ extern NSString *const kSSYKeychainErrorDomain;
  */
 + (NSArray*)accountNamesForServost:(NSString*)servostName
                        trySubhosts:(NSArray*)trySubhosts
-                             class:(NSString*)itemClass
+                             clase:(NSString*)itemClase
                            error_p:(NSError**)error_p ;
 
 

SSYKeychain.m

@@ -11,7 +11,7 @@ @implementation SSYKeychain
 + (NSString*)passwordForServost:(NSString*)servostName
                     trySubhosts:(NSArray*)trySubhosts
                         account:(NSString*)account
-                          class:(NSString*)itemClass
+                          clase:(NSString*)itemClass
                         error_p:(NSError*__autoreleasing*)error_p {
     SSYKeychainQuery *query = [[SSYKeychainQuery alloc] init] ;
     [query setAccount:account] ;
@@ -63,7 +63,7 @@ + (NSString*)passwordForServost:(NSString*)servostName
 
 + (BOOL)deletePasswordForServost:(NSString*)servostName
                          account:(NSString*)account
-                           class:(NSString*)itemClass
+                           clase:(NSString*)itemClass
                          error_p:(NSError*__autoreleasing*)error_p {
     SSYKeychainQuery *query = [[SSYKeychainQuery alloc] init] ;
     if (itemClass) {
@@ -87,7 +87,7 @@ + (BOOL)deletePasswordForServost:(NSString*)servostName
 + (BOOL)setPassword:(NSString*)password
          forServost:(NSString*)servostName
             account:(NSString*)account
-              class:(NSString*)itemClass
+              clase:(NSString*)itemClass
             error_p:(NSError*__autoreleasing*)error_p {
     SSYKeychainQuery *query = [[SSYKeychainQuery alloc] init] ;
     if (itemClass) {
@@ -111,7 +111,7 @@ + (BOOL)setPassword:(NSString*)password
 
 + (NSArray*)allItemsForHost:(NSString*)hostName
                     service:(NSString*)serviceName
-                      class:(NSString*)itemClass {
+                      clase:(NSString*)itemClass {
     SSYKeychainQuery *query = [[SSYKeychainQuery alloc] init] ;
     if (hostName) {
         [query setServer:hostName] ;
@@ -130,26 +130,26 @@ + (NSArray*)allItemsForHost:(NSString*)hostName
     return answer ;
 }
 
-+ (NSArray*)allItemsOfClass:(NSString*)itemClass {
++ (NSArray*)allItemsOfClase:(NSString*)itemClass {
     return [self allItemsForHost:nil
                          service:nil
-                           class:itemClass] ;
+                           clase:itemClass] ;
 }
 
 + (NSArray*)allInternetItemsForHost:(NSString*)hostName {
     return [self allItemsForHost:hostName
                          service:nil
-                           class:(NSString*)(NSString*)kSecClassInternetPassword] ;
+                           clase:(NSString*)(NSString*)kSecClassInternetPassword] ;
 }
 
 + (NSArray*)allGenericItemsForService:(NSString*)serviceName {
     return [self allItemsForHost:nil
                          service:serviceName
-                           class:(NSString*)kSecClassGenericPassword] ;
+                           clase:(NSString*)kSecClassGenericPassword] ;
 }
 
 + (NSArray*)accountNamesForServost:(NSString*)servostName
-                             class:(NSString*)itemClass
+                             clase:(NSString*)itemClass
                            error_p:(NSError**)error_p {
     SSYKeychainQuery *query = [[SSYKeychainQuery alloc] init] ;
     if (itemClass) {
@@ -177,11 +177,11 @@ + (NSArray*)accountNamesForServost:(NSString*)servostName
 
 + (NSArray*)accountNamesForServost:(NSString*)servostName
                        trySubhosts:(NSArray*)trySubhosts
-                             class:(NSString*)itemClass
+                             clase:(NSString*)itemClass
                            error_p:(NSError**)error_p {
     NSError* error = nil ;
     NSArray* array = [self accountNamesForServost:servostName
-                                            class:itemClass
+                                            clase:itemClass
                                           error_p:&error] ;
     if (!array) {
         array = [NSMutableArray array] ;
@@ -195,7 +195,7 @@ + (NSArray*)accountNamesForServost:(NSString*)servostName
                                subhost,
                                servostName] ;
             moreAccounts = [self accountNamesForServost:aHost
-                                                  class:itemClass
+                                                  clase:itemClass
                                                 error_p:&error] ;
             array = [array arrayByAddingObjectsFromArray:moreAccounts] ;
             if (error && ([error code] != errSecItemNotFound)) {

SSYKeychainQuery.h

@@ -79,13 +79,6 @@ typedef NS_ENUM(NSUInteger, SSYKeychainQuerySynchronizationMode) {
 /** Root storage for password information */
 @property (nonatomic, copy) NSData *passwordData ;
 
-/*!
- @brief  Convenience accessor for the receiver's `passwordData` property,
- transformed by NSKeyedArchiver or NSKeyedUnarchiver
- */
-- (id<NSCoding>)passwordObject ;
-- (void)setPasswordObject:(id<NSCoding>)passwordObject ;
-
 /*!
  @brief  Convenience accessor for the receiver's `passwordData` property,
  transformed by UTF8 string encoding */

SSYKeychainQuery.m

@@ -211,20 +211,6 @@ - (BOOL)fetch:(NSError *__autoreleasing *)error_p {
 
 #pragma mark - Accessors
 
-- (void)setPasswordObject:(id<NSCoding>)object {
-    [self setPasswordData:[NSKeyedArchiver archivedDataWithRootObject:object]] ;
-}
-
-
-- (id<NSCoding>)passwordObject {
-    id<NSCoding> answer = nil ;
-    if ([[self passwordData] length] > 0) {
-        answer = [NSKeyedUnarchiver unarchiveObjectWithData:[self passwordData]] ;
-    }
-    return answer ;
-}
-
-
 - (void)setPassword:(NSString *)password {
     [self setPasswordData:[password dataUsingEncoding:NSUTF8StringEncoding]] ;
 }
@@ -361,7 +347,7 @@ + (NSError *)errorWithCode:(NSInteger)code {
             message = (NSString*)SecCopyErrorMessageString((OSStatus)code, NULL) ;
             [message autorelease] ;
 #else
-            message = (__bridge_transfer NSString *)SecCopyErrorMessageString(code, NULL) ;
+            message = (__bridge_transfer NSString *)SecCopyErrorMessageString((int)code, NULL) ;
 #endif
 #endif
     }

SSYOAuthTalker.m

@@ -462,7 +462,7 @@ - (BOOL)getPasswordFromKeychain {
     NSString* password = [SSYKeychain passwordForServost:[self keychainServiceName]
                                              trySubhosts:nil
                                                  account:[[self accounter] accountName]
-                                                   class:(NSString*)kSecClassGenericPassword
+                                                   clase:(NSString*)kSecClassGenericPassword
                                                  error_p:NULL] ;
 	if (password) {
 		// Since the password is accessible i.e. corruptible by the user
@@ -532,7 +532,7 @@ - (void)setPasswordToKeychain {
     [SSYKeychain setPassword:password
                   forServost:[self keychainServiceName]
                      account:[[self accounter] accountName]
-                       class:(NSString*)kSecClassGenericPassword
+                       clase:(NSString*)kSecClassGenericPassword
                      error_p:NULL] ;
 }