src/frontends/android/jni/libandroidbridge/charonservice.h

   1 /*
   2  * Copyright (C) 2012 Tobias Brunner
   3  * Copyright (C) 2012 Giuliano Grassi
   4  * Copyright (C) 2012 Ralf Sager
   5  * Hochschule fuer Technik Rapperswil
   6  *
   7  * This program is free software; you can redistribute it and/or modify it
   8  * under the terms of the GNU General Public License as published by the
   9  * Free Software Foundation; either version 2 of the License, or (at your
  10  * option) any later version.  See <http://www.fsf.org/copyleft/gpl.txt>.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  14  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  15  * for more details.
  16  */
  17
  18 /**
  19  * @defgroup libandroidbridge libandroidbridge
  20  *
  21  * @defgroup android_backend backend
  22  * @ingroup libandroidbridge
  23  *
  24  * @defgroup android_kernel kernel
  25  * @ingroup libandroidbridge
  26  *
  27  * @defgroup charonservice charonservice
  28  * @{ @ingroup libandroidbridge
  29  */
  30
  31 #ifndef CHARONSERVICE_H_
  32 #define CHARONSERVICE_H_
  33
  34 #include "vpnservice_builder.h"
  35
  36 #include <library.h>
  37 #include <utils/linked_list.h>
  38
  39 typedef enum android_vpn_state_t android_vpn_state_t;
  40 typedef struct charonservice_t charonservice_t;
  41
  42 /**
  43  * VPN status codes. As defined in CharonVpnService.java
  44  */
  45 enum android_vpn_state_t {
  46         CHARONSERVICE_CHILD_STATE_UP = 1,
  47         CHARONSERVICE_CHILD_STATE_DOWN,
  48         CHARONSERVICE_AUTH_ERROR,
  49         CHARONSERVICE_PEER_AUTH_ERROR,
  50         CHARONSERVICE_LOOKUP_ERROR,
  51         CHARONSERVICE_UNREACHABLE_ERROR,
  52         CHARONSERVICE_GENERIC_ERROR,
  53 };
  54
  55 /**
  56  * Public interface of charonservice.
  57  *
  58  * Used to communicate with CharonVpnService via JNI
  59  */
  60 struct charonservice_t {
  61
  62         /**
  63          * Update the status in the Java domain (UI)
  64          *
  65          * @param code                  status code
  66          * @return                              TRUE on success
  67          */
  68         bool (*update_status)(charonservice_t *this, android_vpn_state_t code);
  69
  70         /**
  71          * Install a bypass policy for the given socket using the protect() Method
  72          * of the Android VpnService interface
  73          *
  74          * @param fd                    socket file descriptor
  75          * @param family                socket protocol family
  76          * @return                              TRUE if operation successful
  77          */
  78         bool (*bypass_socket)(charonservice_t *this, int fd, int family);
  79
  80         /**
  81          * Get a list of trusted certificates via JNI
  82          *
  83          * @return                              list of DER encoded certificates (as chunk_t*),
  84          *                                              NULL on failure
  85          */
  86         linked_list_t *(*get_trusted_certificates)(charonservice_t *this);
  87
  88         /**
  89          * Get the current vpnservice_builder_t object
  90          *
  91          * @return                              VpnService.Builder instance
  92          */
  93         vpnservice_builder_t *(*get_vpnservice_builder)(charonservice_t *this);
  94
  95 };
  96
  97 /**
  98  * The single instance of charonservice_t.
  99  *
 100  * Set between JNI calls to initializeCharon() and deinitializeCharon().
 101  */
 102 extern charonservice_t *charonservice;
 103
 104 #endif /** CHARONSERVICE_H_ @}*/