mirror of
git://git.gnupg.org/gnupg.git
synced 2024-12-22 10:19:57 +01:00
3a8250c020
* scd/app.c (app_new_register): Call app_munge_serialno for Yubikeys. (app_munge_serialno): Handle Yubikey serial numbers. (card_get_serialno): Remove special Yubikey treatment. Drop arg is_canonical. (app_get_serialno): Clear ERRNO on error. (card_get_dispserialno): New. Also change formatting of Yubikey and OpenPGP numbers to match those printed on the card. (app_get_dispserialno): New. * scd/app-openpgp.c (do_getattr): Use app_get_dispserialno. (yubikey_get_serialno): Remove. * scd/app-piv.c (get_dispserialno): Remove. (do_getattr): Use app_get_dispserialno. -- This patch gets us back to a unique serial number for cards and provides a stable serial number as printed for Yubikeys. Because we use a slightly different serial number now for Yubikeys and cards only supporting OpenPGP card we need to come up with another change so that the version number of OpenPGP serial numbers are ignored when comparing card serial numbers. This is so that existing stub keys of gpg-agent will continue to work. GnuPG-bug-id: 5100 Signed-off-by: Werner Koch <wk@gnupg.org>
347 lines
14 KiB
C
347 lines
14 KiB
C
/* app-common.h - Common declarations for all card applications
|
|
* Copyright (C) 2003, 2005, 2008 Free Software Foundation, Inc.
|
|
*
|
|
* This file is part of GnuPG.
|
|
*
|
|
* GnuPG is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* GnuPG 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 General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, see <https://www.gnu.org/licenses/>.
|
|
*
|
|
* $Id$
|
|
*/
|
|
|
|
#ifndef GNUPG_SCD_APP_COMMON_H
|
|
#define GNUPG_SCD_APP_COMMON_H
|
|
|
|
#include <npth.h>
|
|
#include <ksba.h>
|
|
|
|
/* Flags used with app_change_pin. */
|
|
#define APP_CHANGE_FLAG_RESET 1 /* PIN Reset mode. */
|
|
#define APP_CHANGE_FLAG_NULLPIN 2 /* NULL PIN mode. */
|
|
#define APP_CHANGE_FLAG_CLEAR 4 /* Clear the given PIN. */
|
|
|
|
/* Flags used with app_genkey. */
|
|
#define APP_GENKEY_FLAG_FORCE 1 /* Force overwriting existing key. */
|
|
|
|
/* Flags used with app_writekey. */
|
|
#define APP_WRITEKEY_FLAG_FORCE 1 /* Force overwriting existing key. */
|
|
|
|
/* Flags used with app_readkey. */
|
|
#define APP_READKEY_FLAG_INFO 1 /* Send also a KEYPAIRINFO line. */
|
|
|
|
/* Flags set by the decipher function into R_INFO. */
|
|
#define APP_DECIPHER_INFO_NOPAD 1 /* Padding has been removed. */
|
|
|
|
/* Flags used by the app_write_learn_status. */
|
|
#define APP_LEARN_FLAG_KEYPAIRINFO 1 /* Return only keypair infos. */
|
|
#define APP_LEARN_FLAG_MULTI 2 /* Return info for all apps. */
|
|
|
|
|
|
/* List of supported card types. Generic is the usual ISO7817-4
|
|
* compliant card. More specific card or token versions can be given
|
|
* here. Use strcardtype() to map them to a string. */
|
|
typedef enum
|
|
{
|
|
CARDTYPE_GENERIC = 0,
|
|
CARDTYPE_GNUK,
|
|
CARDTYPE_YUBIKEY,
|
|
CARDTYPE_ZEITCONTROL
|
|
|
|
} cardtype_t;
|
|
|
|
/* List of supported card applications. The source code for each
|
|
* application can usually be found in an app-NAME.c file. Use
|
|
* strapptype() to map them to a string. */
|
|
typedef enum
|
|
{
|
|
APPTYPE_NONE = 0,
|
|
APPTYPE_UNDEFINED,
|
|
APPTYPE_OPENPGP,
|
|
APPTYPE_PIV,
|
|
APPTYPE_NKS,
|
|
APPTYPE_P15,
|
|
APPTYPE_GELDKARTE,
|
|
APPTYPE_DINSIG,
|
|
APPTYPE_SC_HSM
|
|
} apptype_t;
|
|
|
|
|
|
/* Forward declarations. */
|
|
struct card_ctx_s;
|
|
struct app_ctx_s;
|
|
struct app_local_s; /* Defined by all app-*.c. */
|
|
|
|
|
|
typedef struct card_ctx_s *card_t;
|
|
typedef struct app_ctx_s *app_t;
|
|
|
|
/* The object describing a card. */
|
|
struct card_ctx_s {
|
|
card_t next;
|
|
|
|
npth_mutex_t lock;
|
|
|
|
/* Number of connections currently using this application context. */
|
|
unsigned int ref_count;
|
|
|
|
/* Used reader slot. */
|
|
int slot;
|
|
|
|
cardtype_t cardtype; /* The token's type. */
|
|
unsigned int cardversion;/* Firmware version of the token or 0. */
|
|
|
|
unsigned int card_status;
|
|
|
|
/* The serial number is associated with the card and not with a
|
|
* specific app. If a card uses different serial numbers for its
|
|
* applications, our code picks the serial number of a specific
|
|
* application and uses that. */
|
|
unsigned char *serialno; /* Serialnumber in raw form, allocated. */
|
|
size_t serialnolen; /* Length in octets of serialnumber. */
|
|
|
|
/* A linked list of applications used on this card. The app at the
|
|
* head of the list is the currently active app; To work with the
|
|
* other apps, switching to that app might be needed. Switching will
|
|
* put the active app at the head of the list. */
|
|
app_t app;
|
|
|
|
/* Various flags. */
|
|
unsigned int reset_requested:1;
|
|
unsigned int periodical_check_needed:1;
|
|
};
|
|
|
|
|
|
/* The object describing a card's applications. A card may have
|
|
* several applications and it is usually required to explicitly
|
|
* switch between applications. */
|
|
struct app_ctx_s {
|
|
app_t next;
|
|
|
|
card_t card; /* Link back to the card. */
|
|
|
|
apptype_t apptype; /* The type of the application. */
|
|
unsigned int appversion; /* Version of the application or 0. */
|
|
unsigned int did_chv1:1;
|
|
unsigned int force_chv1:1; /* True if the card does not cache CHV1. */
|
|
unsigned int did_chv2:1;
|
|
unsigned int did_chv3:1;
|
|
struct app_local_s *app_local; /* Local to the application. */
|
|
struct {
|
|
void (*deinit) (app_t app);
|
|
gpg_error_t (*prep_reselect) (app_t app, ctrl_t ctrl);
|
|
gpg_error_t (*reselect) (app_t app, ctrl_t ctrl);
|
|
gpg_error_t (*learn_status) (app_t app, ctrl_t ctrl, unsigned int flags);
|
|
gpg_error_t (*readcert) (app_t app, const char *certid,
|
|
unsigned char **cert, size_t *certlen);
|
|
gpg_error_t (*readkey) (app_t app, ctrl_t ctrl,
|
|
const char *certid, unsigned int flags,
|
|
unsigned char **pk, size_t *pklen);
|
|
gpg_error_t (*getattr) (app_t app, ctrl_t ctrl, const char *name);
|
|
gpg_error_t (*setattr) (app_t app, ctrl_t ctrl, const char *name,
|
|
gpg_error_t (*pincb)(void*, const char *, char **),
|
|
void *pincb_arg,
|
|
const unsigned char *value, size_t valuelen);
|
|
gpg_error_t (*sign) (app_t app, ctrl_t ctrl,
|
|
const char *keyidstr, int hashalgo,
|
|
gpg_error_t (*pincb)(void*, const char *, char **),
|
|
void *pincb_arg,
|
|
const void *indata, size_t indatalen,
|
|
unsigned char **outdata, size_t *outdatalen );
|
|
gpg_error_t (*auth) (app_t app, ctrl_t ctrl, const char *keyidstr,
|
|
gpg_error_t (*pincb)(void*, const char *, char **),
|
|
void *pincb_arg,
|
|
const void *indata, size_t indatalen,
|
|
unsigned char **outdata, size_t *outdatalen);
|
|
gpg_error_t (*decipher) (app_t app, ctrl_t ctrl, const char *keyidstr,
|
|
gpg_error_t (*pincb)(void*, const char *, char **),
|
|
void *pincb_arg,
|
|
const void *indata, size_t indatalen,
|
|
unsigned char **outdata, size_t *outdatalen,
|
|
unsigned int *r_info);
|
|
gpg_error_t (*writecert) (app_t app, ctrl_t ctrl,
|
|
const char *certid,
|
|
gpg_error_t (*pincb)(void*,const char *,char **),
|
|
void *pincb_arg,
|
|
const unsigned char *data, size_t datalen);
|
|
gpg_error_t (*writekey) (app_t app, ctrl_t ctrl,
|
|
const char *keyid, unsigned int flags,
|
|
gpg_error_t (*pincb)(void*,const char *,char **),
|
|
void *pincb_arg,
|
|
const unsigned char *pk, size_t pklen);
|
|
gpg_error_t (*genkey) (app_t app, ctrl_t ctrl,
|
|
const char *keyref, const char *keytype,
|
|
unsigned int flags, time_t createtime,
|
|
gpg_error_t (*pincb)(void*, const char *, char **),
|
|
void *pincb_arg);
|
|
gpg_error_t (*change_pin) (app_t app, ctrl_t ctrl,
|
|
const char *chvnostr, unsigned int flags,
|
|
gpg_error_t (*pincb)(void*, const char *, char **),
|
|
void *pincb_arg);
|
|
gpg_error_t (*check_pin) (app_t app, ctrl_t ctrl, const char *keyidstr,
|
|
gpg_error_t (*pincb)(void*, const char *, char **),
|
|
void *pincb_arg);
|
|
gpg_error_t (*with_keygrip) (app_t app, ctrl_t ctrl, int action,
|
|
const char *keygrip_str, int capability);
|
|
} fnc;
|
|
};
|
|
|
|
|
|
/* Action values for app_do_with_keygrip. */
|
|
enum
|
|
{
|
|
KEYGRIP_ACTION_SEND_DATA,
|
|
KEYGRIP_ACTION_WRITE_STATUS,
|
|
KEYGRIP_ACTION_LOOKUP
|
|
};
|
|
|
|
|
|
/* Helper to get the slot from an APP object. */
|
|
static inline int
|
|
app_get_slot (app_t app)
|
|
{
|
|
if (app && app->card)
|
|
return app->card->slot;
|
|
return -1;
|
|
}
|
|
|
|
|
|
/*-- app-help.c --*/
|
|
unsigned int app_help_count_bits (const unsigned char *a, size_t len);
|
|
gpg_error_t app_help_get_keygrip_string_pk (const void *pk, size_t pklen,
|
|
char *hexkeygrip,
|
|
gcry_sexp_t *r_pkey,
|
|
int *r_algo, char **r_algostr);
|
|
gpg_error_t app_help_get_keygrip_string (ksba_cert_t cert, char *hexkeygrip,
|
|
gcry_sexp_t *r_pkey, int *r_algo);
|
|
gpg_error_t app_help_pubkey_from_cert (const void *cert, size_t certlen,
|
|
unsigned char **r_pk, size_t *r_pklen);
|
|
size_t app_help_read_length_of_cert (int slot, int fid, size_t *r_certoff);
|
|
|
|
|
|
/*-- app.c --*/
|
|
const char *strcardtype (cardtype_t t);
|
|
const char *strapptype (apptype_t t);
|
|
|
|
void app_update_priority_list (const char *arg);
|
|
gpg_error_t app_send_card_list (ctrl_t ctrl);
|
|
gpg_error_t app_send_active_apps (card_t card, ctrl_t ctrl);
|
|
char *card_get_serialno (card_t card);
|
|
char *app_get_serialno (app_t app);
|
|
char *card_get_dispserialno (card_t card, int nofallback);
|
|
char *app_get_dispserialno (app_t app, int nofallback);
|
|
|
|
void app_dump_state (void);
|
|
void application_notify_card_reset (int slot);
|
|
gpg_error_t check_application_conflict (card_t card, const char *name,
|
|
const unsigned char *serialno_bin,
|
|
size_t serialno_bin_len);
|
|
gpg_error_t card_reset (card_t card, ctrl_t ctrl, int send_reset);
|
|
gpg_error_t select_application (ctrl_t ctrl, const char *name, card_t *r_app,
|
|
int scan, const unsigned char *serialno_bin,
|
|
size_t serialno_bin_len);
|
|
gpg_error_t select_additional_application (ctrl_t ctrl, const char *name);
|
|
|
|
gpg_error_t app_switch_current_card (ctrl_t ctrl,
|
|
const unsigned char *serialno,
|
|
size_t serialnolen);
|
|
gpg_error_t app_switch_active_app (card_t card, ctrl_t ctrl,
|
|
const char *appname);
|
|
|
|
char *get_supported_applications (void);
|
|
|
|
card_t card_ref (card_t card);
|
|
void card_unref (card_t card);
|
|
void card_unref_locked (card_t card);
|
|
|
|
gpg_error_t app_munge_serialno (card_t card);
|
|
gpg_error_t app_write_learn_status (card_t card, ctrl_t ctrl,
|
|
unsigned int flags);
|
|
gpg_error_t app_readcert (card_t card, ctrl_t ctrl, const char *certid,
|
|
unsigned char **cert, size_t *certlen);
|
|
gpg_error_t app_readkey (card_t card, ctrl_t ctrl,
|
|
const char *keyid, unsigned int flags,
|
|
unsigned char **pk, size_t *pklen);
|
|
gpg_error_t app_getattr (card_t card, ctrl_t ctrl, const char *name);
|
|
gpg_error_t app_setattr (card_t card, ctrl_t ctrl, const char *name,
|
|
gpg_error_t (*pincb)(void*, const char *, char **),
|
|
void *pincb_arg,
|
|
const unsigned char *value, size_t valuelen);
|
|
gpg_error_t app_sign (card_t card, ctrl_t ctrl,
|
|
const char *keyidstr, int hashalgo,
|
|
gpg_error_t (*pincb)(void*, const char *, char **),
|
|
void *pincb_arg,
|
|
const void *indata, size_t indatalen,
|
|
unsigned char **outdata, size_t *outdatalen);
|
|
gpg_error_t app_auth (card_t card, ctrl_t ctrl, const char *keyidstr,
|
|
gpg_error_t (*pincb)(void*, const char *, char **),
|
|
void *pincb_arg,
|
|
const void *indata, size_t indatalen,
|
|
unsigned char **outdata, size_t *outdatalen);
|
|
gpg_error_t app_decipher (card_t card, ctrl_t ctrl, const char *keyidstr,
|
|
gpg_error_t (*pincb)(void*, const char *, char **),
|
|
void *pincb_arg,
|
|
const void *indata, size_t indatalen,
|
|
unsigned char **outdata, size_t *outdatalen,
|
|
unsigned int *r_info);
|
|
gpg_error_t app_writecert (card_t card, ctrl_t ctrl,
|
|
const char *certidstr,
|
|
gpg_error_t (*pincb)(void*, const char *, char **),
|
|
void *pincb_arg,
|
|
const unsigned char *keydata, size_t keydatalen);
|
|
gpg_error_t app_writekey (card_t card, ctrl_t ctrl,
|
|
const char *keyidstr, unsigned int flags,
|
|
gpg_error_t (*pincb)(void*, const char *, char **),
|
|
void *pincb_arg,
|
|
const unsigned char *keydata, size_t keydatalen);
|
|
gpg_error_t app_genkey (card_t card, ctrl_t ctrl,
|
|
const char *keynostr, const char *keytype,
|
|
unsigned int flags, time_t createtime,
|
|
gpg_error_t (*pincb)(void*, const char *, char **),
|
|
void *pincb_arg);
|
|
gpg_error_t app_get_challenge (card_t card, ctrl_t ctrl, size_t nbytes,
|
|
unsigned char *buffer);
|
|
gpg_error_t app_change_pin (card_t card, ctrl_t ctrl,
|
|
const char *chvnostr, unsigned int flags,
|
|
gpg_error_t (*pincb)(void*, const char *, char **),
|
|
void *pincb_arg);
|
|
gpg_error_t app_check_pin (card_t card, ctrl_t ctrl, const char *keyidstr,
|
|
gpg_error_t (*pincb)(void*, const char *, char **),
|
|
void *pincb_arg);
|
|
card_t app_do_with_keygrip (ctrl_t ctrl, int action, const char *keygrip_str,
|
|
int capability);
|
|
|
|
|
|
/*-- app-openpgp.c --*/
|
|
gpg_error_t app_select_openpgp (app_t app);
|
|
|
|
/*-- app-nks.c --*/
|
|
gpg_error_t app_select_nks (app_t app);
|
|
|
|
/*-- app-dinsig.c --*/
|
|
gpg_error_t app_select_dinsig (app_t app);
|
|
|
|
/*-- app-p15.c --*/
|
|
gpg_error_t app_select_p15 (app_t app);
|
|
|
|
/*-- app-geldkarte.c --*/
|
|
gpg_error_t app_select_geldkarte (app_t app);
|
|
|
|
/*-- app-sc-hsm.c --*/
|
|
gpg_error_t app_select_sc_hsm (app_t app);
|
|
|
|
/*-- app-piv.c --*/
|
|
gpg_error_t app_select_piv (app_t app);
|
|
|
|
|
|
#endif /*GNUPG_SCD_APP_COMMON_H*/
|