include/gammu-security.h

   1 /**
   2  * \file gammu-security.h
   3  * \author Michal Čihař
   4  *
   5  * Security functions.
   6  */
   7 #ifndef __gammu_security_h
   8 #define __gammu_security_h
   9
  10 /**
  11  * \defgroup Security Security
  12  * Security related operations with phone.
  13  */
  14
  15 #include <gammu-limits.h>
  16 #include <gammu-error.h>
  17 #include <gammu-statemachine.h>
  18
  19 /**
  20  * Definition of security codes.
  21  *
  22  * \ingroup Security
  23  */
  24 typedef enum {
  25         /**
  26          * Security code.
  27          */
  28         SEC_SecurityCode = 0x01,
  29         /**
  30          * PIN.
  31          */
  32         SEC_Pin,
  33         /**
  34          * PIN 2.
  35          */
  36         SEC_Pin2,
  37         /**
  38          * PUK.
  39          */
  40         SEC_Puk,
  41         /**
  42          * PUK 2.
  43          */
  44         SEC_Puk2,
  45         /**
  46          * Code not needed.
  47          */
  48         SEC_None,
  49         /**
  50          * Phone code needed.
  51          */
  52         SEC_Phone,
  53         /**
  54          * Network code needed.
  55          */
  56         SEC_Network,
  57 } GSM_SecurityCodeType;
  58
  59 /**
  60  * Security code definition.
  61  *
  62  * \ingroup Security
  63  */
  64 typedef struct {
  65         /**
  66          * Type of the code.
  67          */
  68         GSM_SecurityCodeType Type;
  69         /**
  70          * Actual code.
  71          */
  72         char Code[GSM_SECURITY_CODE_LEN + 1];
  73         /**
  74          * New PIN code.
  75          *
  76          * Some phones require to set PIN on entering PUK, you can
  77          * provide it here.
  78          */
  79         char NewPIN[GSM_SECURITY_CODE_LEN + 1];
  80 } GSM_SecurityCode;
  81
  82 /**
  83  * Enters security code (PIN, PUK,...) .
  84  *
  85  * \ingroup Security
  86  */
  87 GSM_Error GSM_EnterSecurityCode(GSM_StateMachine * s, GSM_SecurityCode * Code);
  88
  89 /**
  90  * Queries whether some security code needs to be entered.
  91  *
  92  * \ingroup Security
  93  */
  94 GSM_Error GSM_GetSecurityStatus(GSM_StateMachine * s,
  95                                 GSM_SecurityCodeType * Status);
  96
  97 #endif
  98
  99 /* Editor configuration
 100  * vim: noexpandtab sw=8 ts=8 sts=8 tw=72:
 101  */