gpg: Improve function documentation and some comments.
[gnupg.git] / g10 / seckey-cert.c
index fed9213..02dbb48 100644 (file)
@@ -1,4 +1,4 @@
-/* seckey-cert.c -  secret key certificate packet handling
+/* seckey-cert.c - Not anymore used
  * Copyright (C) 1998, 1999, 2000, 2001, 2002,
  *               2006, 2009 Free Software Foundation, Inc.
  *
@@ -18,6 +18,8 @@
  * along with this program; if not, see <http://www.gnu.org/licenses/>.
  */
 
+#error Not anymore used - only kept for reference in the repository.
+
 #include <config.h>
 #include <stdio.h>
 #include <stdlib.h>
@@ -36,8 +38,8 @@
 #include "pkglue.h"
 
 static int
-do_check( PKT_secret_key *sk, const char *tryagain_text, int mode,
-          int *canceled )
+xxxx_do_check( PKT_secret_key *sk, const char *tryagain_text, int mode,
+               int *canceled )
 {
     gpg_error_t err;
     byte *buffer;
@@ -53,32 +55,28 @@ do_check( PKT_secret_key *sk, const char *tryagain_text, int mode,
 
        if( sk->protect.s2k.mode == 1001 ) {
            log_info(_("secret key parts are not available\n"));
-           return G10ERR_UNU_SECKEY;
+           return GPG_ERR_UNUSABLE_SECKEY;
        }
        if( sk->protect.algo == CIPHER_ALGO_NONE )
            BUG();
        if( openpgp_cipher_test_algo( sk->protect.algo ) ) {
            log_info(_("protection algorithm %d%s is not supported\n"),
                        sk->protect.algo,sk->protect.algo==1?" (IDEA)":"" );
-           if (sk->protect.algo==CIPHER_ALGO_IDEA)
-              {
-                write_status (STATUS_RSA_OR_IDEA);
-                idea_cipher_warn (0);
-              }
-           return G10ERR_CIPHER_ALGO;
+           return GPG_ERR_CIPHER_ALGO;
        }
        if(gcry_md_test_algo (sk->protect.s2k.hash_algo))
          {
            log_info(_("protection digest %d is not supported\n"),
                     sk->protect.s2k.hash_algo);
-           return G10ERR_DIGEST_ALGO;
+           return GPG_ERR_DIGEST_ALGO;
          }
        keyid_from_sk( sk, keyid );
        keyid[2] = keyid[3] = 0;
-       if( !sk->is_primary ) {
+       if (!sk->flags.primary)
+          {
             keyid[2] = sk->main_keyid[0];
             keyid[3] = sk->main_keyid[1];
-       }
+          }
        dek = passphrase_to_dek( keyid, sk->pubkey_algo, sk->protect.algo,
                                 &sk->protect.s2k, mode,
                                  tryagain_text, canceled );
@@ -117,7 +115,7 @@ do_check( PKT_secret_key *sk, const char *tryagain_text, int mode,
             ndata = (ndatabits+7)/8;
 
             if ( ndata > 1 )
-                csumc = p[ndata-2] << 8 | p[ndata-1];
+              csumc = buf16_to_u16 (p+ndata-2);
            data = xmalloc_secure ( ndata );
            gcry_cipher_decrypt ( cipher_hd, data, ndata, p, ndata );
            gcry_mpi_release (sk->skey[i]); sk->skey[i] = NULL ;
@@ -129,7 +127,7 @@ do_check( PKT_secret_key *sk, const char *tryagain_text, int mode,
                    attack */
                 sk->csum = 0;
                 csum = 1;
-                if( ndata < 20 ) 
+                if( ndata < 20 )
                     log_error("not enough bytes for SHA-1 checksum\n");
                 else {
                     gcry_md_hd_t h;
@@ -139,7 +137,7 @@ do_check( PKT_secret_key *sk, const char *tryagain_text, int mode,
                     gcry_md_write (h, data, ndata - 20);
                     gcry_md_final (h);
                     if (!memcmp (gcry_md_read (h, DIGEST_ALGO_SHA1),
-                                 data + ndata - 20, 20) ) 
+                                 data + ndata - 20, 20) )
                       {
                         /* Digest does match.  We have to keep the old
                            style checksum in sk->csum, so that the
@@ -147,7 +145,7 @@ do_check( PKT_secret_key *sk, const char *tryagain_text, int mode,
                            This test gets used when we are adding new
                            keys. */
                         sk->csum = csum = checksum (data, ndata-20);
-                      } 
+                      }
                     gcry_md_close (h);
                 }
             }
@@ -251,25 +249,8 @@ do_check( PKT_secret_key *sk, const char *tryagain_text, int mode,
            csum += checksum_mpi( sk->skey[i] );
        }
        if( csum != sk->csum )
-           return G10ERR_CHECKSUM;
+           return GPG_ERR_CHECKSUM;
     }
 
     return 0;
 }
-
-
-
-/****************
- * check whether the secret key is protected.
- * Returns: 0 not protected, -1 on error or the protection algorithm
- *                           -2 indicates a card stub.
- *                           -3 indicates a not-online stub.
- */
-int
-is_secret_key_protected (PKT_public_key *pk)
-{
-  return 0; /* FIXME:  use agent_get_keyinfo?*/
-    /* return sk->is_protected? */
-    /*            sk->protect.s2k.mode == 1002? -2 : */
-    /*            sk->protect.s2k.mode == 1001? -3 : sk->protect.algo : 0; */
-}