AnyConnect Secure Mobility Client 4.8.02045

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