AnyConnect Secure Mobility Client 4.4.00243

include/GlobalEnums.h

00001 /*******************************************************************************
00002 *                   COPYRIGHT 2007 - Cisco Systems 
00003 *                   All Rights Reserved
00004 ********************************************************************************
00005 **
00006 **  GlobalEnums.h
00007 **  
00008 **  Contains enumerations used in the API and TLV classes.
00009 **
00010 *********************************************************************************/
00011 
00012 #ifndef __GLOBALENUMS_H
00013 #define __GLOBALENUMS_H
00014 
00015 /*****    PUT ONLY ENUMS IN THIS FILE AS IT IS ALSO USED BY THE MIDL COMPILER  *****\
00016 \******************** This is also compiled with IDL compiler **********************/
00017 
00018 enum ConnectProtocolType
00019 {
00020     PROTOCOL_TYPE_UNKNOWN = 0,
00021     PROTOCOL_TYPE_SSL,
00022     PROTOCOL_TYPE_IPSEC,
00023 };
00024 
00025 enum ProtocolVersion 
00026 {
00027     PROTO_VERSION_UNKNOWN           = 0,
00028     PROTO_VERSION_TLS10             = 1,
00029     PROTO_VERSION_SSL30             = 2,
00030     PROTO_VERSION_DTLS10            = 3,
00031     PROTO_VERSION_IPSEC             = 4,
00032     PROTO_VERSION_IPSEC_NAT_T       = 5,
00033     PROTO_VERSION_TLS11             = 6,
00034     PROTO_VERSION_TLS12             = 7,
00035 };
00036 
00037 enum ProtocolCipher
00038 {
00039     PROTO_CIPHER_UNKNOWN            =  0,
00040     PROTO_CIPHER_RSA_RC4_128_MD5    =  1,
00041     PROTO_CIPHER_RSA_RC4_128_SHA1   =  2,
00042     PROTO_CIPHER_RSA_DES_56_SHA1    =  3,
00043     PROTO_CIPHER_RSA_3DES_168_SHA1  =  4,
00044     PROTO_CIPHER_RSA_AES_128_SHA1   =  5,
00045     PROTO_CIPHER_RSA_AES_256_SHA1   =  6,
00046     PROTO_CIPHER_ENC_NULL_MD5       =  7,
00047     PROTO_CIPHER_ENC_NULL_SHA1      =  8,
00048     PROTO_CIPHER_RC4_128            =  9,
00049     PROTO_CIPHER_RC4_128_MD5        = 10,
00050     PROTO_CIPHER_RC4_128_SHA1       = 11,
00051     PROTO_CIPHER_DES_56             = 12,
00052     PROTO_CIPHER_DES_56_MD5         = 13,
00053     PROTO_CIPHER_DES_56_SHA1        = 14,
00054     PROTO_CIPHER_DES_56_SHA256      = 15,
00055     PROTO_CIPHER_DES_56_SHA384      = 16,
00056     PROTO_CIPHER_DES_56_SHA512      = 17,
00057     PROTO_CIPHER_3DES_168           = 18,
00058     PROTO_CIPHER_3DES_168_MD5       = 19,
00059     PROTO_CIPHER_3DES_168_SHA1      = 20,
00060     PROTO_CIPHER_3DES_168_SHA256    = 21,
00061     PROTO_CIPHER_3DES_168_SHA384    = 22,
00062     PROTO_CIPHER_3DES_168_SHA512    = 23,
00063     PROTO_CIPHER_AES_128            = 24,
00064     PROTO_CIPHER_AES_128_MD5        = 25,
00065     PROTO_CIPHER_AES_128_SHA1       = 26,
00066     PROTO_CIPHER_AES_128_SHA256     = 27,
00067     PROTO_CIPHER_AES_128_SHA384     = 28,
00068     PROTO_CIPHER_AES_128_SHA512     = 29,
00069     PROTO_CIPHER_AES_192            = 30,
00070     PROTO_CIPHER_AES_192_MD5        = 31,
00071     PROTO_CIPHER_AES_192_SHA1       = 32,
00072     PROTO_CIPHER_AES_192_SHA256     = 33,
00073     PROTO_CIPHER_AES_192_SHA384     = 34,
00074     PROTO_CIPHER_AES_192_SHA512     = 35,
00075     PROTO_CIPHER_AES_256            = 36,
00076     PROTO_CIPHER_AES_256_MD5        = 37,
00077     PROTO_CIPHER_AES_256_SHA1       = 38,
00078     PROTO_CIPHER_AES_256_SHA256     = 39,
00079     PROTO_CIPHER_AES_256_SHA384     = 40,
00080     PROTO_CIPHER_AES_256_SHA512     = 41,
00081     PROTO_CIPHER_AES_128_GCM        = 42,
00082     PROTO_CIPHER_AES_192_GCM        = 43,
00083     PROTO_CIPHER_AES_256_GCM        = 44,
00084     PROTO_CIPHER_RSA_AES_128_SHA256 = 45,   // TLS 1.2
00085     PROTO_CIPHER_RSA_AES_256_SHA256 = 46,
00086     PROTO_CIPHER_DHE_RSA_AES_128_SHA256 = 47,
00087     PROTO_CIPHER_DHE_RSA_AES_256_SHA256 = 48,
00088     PROTO_CIPHER_ECDHE_ECDSA_AES256_GCM_SHA384 = 49,    // TLS 1.2 phase 2
00089     PROTO_CIPHER_ECDHE_RSA_AES256_GCM_SHA384   = 50,
00090     PROTO_CIPHER_DHE_RSA_AES256_GCM_SHA384     = 51,
00091     PROTO_CIPHER_AES256_GCM_SHA384             = 52,
00092     PROTO_CIPHER_ECDHE_ECDSA_AES256_SHA384     = 53,
00093     PROTO_CIPHER_ECDHE_RSA_AES256_SHA384       = 54,
00094     PROTO_CIPHER_ECDHE_ECDSA_AES128_GCM_SHA256 = 55,
00095     PROTO_CIPHER_ECDHE_RSA_AES128_GCM_SHA256   = 56,
00096     PROTO_CIPHER_DHE_RSA_AES128_GCM_SHA256     = 57,
00097     PROTO_CIPHER_AES128_GCM_SHA256             = 58,
00098     PROTO_CIPHER_ECDHE_ECDSA_AES128_SHA256     = 59,
00099     PROTO_CIPHER_ECDHE_RSA_AES128_SHA256       = 60,
00100     PROTO_CIPHER_DHE_RSA_AES256_SHA            = 61,
00101     PROTO_CIPHER_DHE_RSA_AES128_SHA            = 62
00102 };
00103 
00104 typedef enum
00105 {
00106     COMPR_NONE = 0,
00107     COMPR_DEFLATE = 1,
00108     COMPR_LZS = 2
00109 } COMPR_ALGORITHM;   
00110 
00111 /*
00112 ** Tunnel states
00113 **  New states must be added to the end of the list.
00114 **  Downloader tests states, so altering existing states requires verification
00115 **  that there won't be backward compability issues with downloader.
00116 */
00117 //BUGBUG  Suggested by Marc: Rename the STATE enum and its values.
00118 //BUGBUG  We should probably change the enum name from STATE to VPNCON_STATE and
00119 //BUGBUG  the prefixes on the values from STATE_ to VCS_ (for VPN connection state).
00120 //BUGBUG  The API and GUI code have to deal with a number of different states, and the 
00121 //BUGBUG  generically named STATE is not very self documenting.
00122 //BUGBUG  It's a throw back from the very earliest code for SSL VPN.
00123 typedef enum
00124 {
00125     STATE_CONNECTING,
00126     STATE_CONNECTED,
00127     STATE_RECONNECTING,
00128     STATE_DISCONNECTING,
00129     STATE_DISCONNECTED,
00130     STATE_PAUSING,
00131     STATE_PAUSED,
00132     STATE_AUTHENTICATING,
00133     STATE_SSOPOLLING,       // Api is doing the auth-poll.
00134     STATE_UNDEFINED,
00135 } STATE;
00136 
00137 /*
00138 ** Tunnel sub-states
00139 **  New sub-states must be added to the end of the list.
00140 **  Sub-states are meant to provide additional details, if necessary, about 
00141 **  any of the VPN connection states.
00142 */
00143 enum VPNCON_SUBSTATE
00144 {
00145     VCSS_NORMAL              = 0,
00146     VCSS_INDEFINITE_DELAY    = (1 << 0),
00147     VCSS_SESSION_EXPIRING    = (1 << 1)
00148 };
00149 
00150 typedef enum
00151 {
00152     NCS_RESTRICTED = 0, //a client configuration has been applied to the endpoints 
00153                         //operating system configuration
00154     NCS_PARTIAL_RESTRICTED_CAPTIVE_PORTAL, //a client configuration has been applied to the 
00155                                            //endpoints operating system configuration to allow
00156                                            //captive portal remediation
00157     NCS_UNRESTRICTED    //the endpoints operating system configuration is not currently altered by the client
00158 } NETCTRL_STATE;
00159 
00160 
00161 // Note that while these values are defined like a bitmap, the network environment state
00162 // is not used as a bitmap. No two values are ever combined.  They are used like linear
00163 // values. The bitmap arrangement of values is to enable testing for many possible values
00164 // all at once in a single compare without having to do a series of compares against
00165 // different linear values.
00166 //
00167 typedef enum
00168 {
00169     NES_NO_NETWORK_INTERFACE        = (1 << 0),
00170     NES_NO_PUBLIC_INTERFACE         = (1 << 1),
00171     NES_NO_DNS_CONNECTIVITY         = (1 << 2),
00172     NES_CAPTIVE_PORTAL_DETECTED     = (1 << 3),
00173     NES_AUTH_PROXY_DETECTED         = (1 << 4),
00174     NES_NETWORK_ACCESSIBLE          = (1 << 5),
00175     NES_SECURE_GATEWAY_ACCESSIBLE   = (1 << 6)
00176 } NETENV_STATE;
00177 
00178 
00179 // Trusted Network Detection types.
00180 typedef enum
00181 {
00182     NT_TRUSTED,
00183     NT_UNTRUSTED,
00184     NT_UNDEFINED
00185 } NETWORK_TYPE;
00186 
00187 // Firewall enums
00188 typedef enum
00189 {   FW_PERMISSION_UNKNOWN,
00190     FW_PERMISSION_PERMIT,
00191     FW_PERMISSION_DENY
00192 } FW_Permission;
00193 
00194 typedef enum
00195 {   FW_PROTOCOL_UNKNOWN,
00196     FW_PROTOCOL_TCP,
00197     FW_PROTOCOL_UDP,
00198     FW_PROTOCOL_ICMP,
00199     FW_PROTOCOL_ANY
00200 } FW_Protocol;
00201 
00202 typedef enum
00203 {
00204     FW_INTERFACE_UNKNOWN,
00205     FW_INTERFACE_PUBLIC,
00206     FW_INTERFACE_PRIVATE
00207 } FW_Interface;
00208 
00209 typedef enum
00210 {
00211     FW_RULE_DIRECTION_IN,
00212     FW_RULE_DIRECTION_OUT,
00213     FW_RULE_DIRECTION_BOTH
00214 } FW_Rule_Direction;
00215 
00216 typedef enum
00217 {
00218     MUS_STATUS_UNKNOWN = 0,
00219     MUS_STATUS_ENABLED,
00220     MUS_STATUS_DISABLED,
00221     MUS_STATUS_UNCONFIRMED
00222 } MUS_STATUS;
00223 
00224 // These can be used to get/set an automatic preference value using the
00225 // generic UserPreferences.getAutomaticPreferenceValue() and
00226 // setAutomaticPreferenceValue() methods, rather than using the individual
00227 // getters/setters.
00228 typedef enum 
00229 {   
00230     HeadendSelectionCacheId = 0,
00231     DefaultUserId,
00232     DefaultSecondUserId,
00233     DefaultHostId,
00234     DefaultGroupId,
00235     ProxyHostId,
00236     ProxyPortId,
00237     SDITokenTypeId,
00238     NoSDITokenId,
00239     ClientCertThumbprintId,
00240     ServerCertThumbprintId,
00241     UnknownAutomaticPreference
00242 }  AutoPreferenceId ;
00243 
00244 // Used to determine if CPublicProxies, CPrivateProxies or no proxies should be used.
00245 typedef enum
00246 {
00247     TRANSPORT_PROXY_NONE,
00248     TRANSPORT_PROXY_PUBLIC,
00249     TRANSPORT_PROXY_CURRENT
00250 } TRANSPORT_PROXY_TYPE;
00251 
00252 // user authentication methods
00253 // these are shared between Agent and API
00254 //
00255 // Note that IKE PSK is supported for reconnects only.  The API can never
00256 // initiate an IPsec connection using IKE PSK authentication.
00257 typedef enum
00258 {
00259     USER_AUTH_UNKNOWN = 0,
00260     USER_AUTH_SSL_MACHINE_STORE_CERT,
00261     USER_AUTH_IKE_PSK,
00262     USER_AUTH_IKE_RSA,
00263     USER_AUTH_IKE_ECDSA,
00264     USER_AUTH_IKE_EAP_MD5,
00265     USER_AUTH_IKE_EAP_MSCHAPv2,
00266     USER_AUTH_IKE_EAP_GTC,
00267     USER_AUTH_IKE_EAP_ANYCONNECT,  // Default
00268 } USER_AUTH_METHOD;
00269 
00270 typedef enum
00271 {
00272     CFR_NONE = 0,
00273     CFR_HOST_UNREACHABLE,
00274 } CONNECT_FAILURE_REASON;
00275 
00276 #endif // __GLOBALENUMS_H