Harald Welte | 288be16 | 2010-05-01 16:48:27 +0200 | [diff] [blame] | 1 | #ifndef _SGSN_H |
| 2 | #define _SGSN_H |
| 3 | |
Harald Welte | 288be16 | 2010-05-01 16:48:27 +0200 | [diff] [blame] | 4 | |
Pablo Neira Ayuso | 136f453 | 2011-03-22 16:47:59 +0100 | [diff] [blame] | 5 | #include <osmocom/core/msgb.h> |
Alexander Couzens | f23e2db | 2020-07-27 22:39:58 +0200 | [diff] [blame] | 6 | #include <osmocom/core/select.h> |
Max | 93408ae | 2016-06-28 14:10:16 +0200 | [diff] [blame] | 7 | #include <osmocom/crypt/gprs_cipher.h> |
Alexander Couzens | f23e2db | 2020-07-27 22:39:58 +0200 | [diff] [blame] | 8 | #include <osmocom/gprs/gprs_ns2.h> |
Pau Espin Pedrol | e5c8998 | 2021-05-03 18:16:42 +0200 | [diff] [blame] | 9 | #include <osmocom/gprs/gprs_bssgp.h> |
| 10 | |
Pau Espin Pedrol | 58101ea | 2023-01-09 12:29:27 +0100 | [diff] [blame^] | 11 | #include <osmocom/sgsn/auth.h> |
Pau Espin Pedrol | e5c8998 | 2021-05-03 18:16:42 +0200 | [diff] [blame] | 12 | #include <osmocom/sgsn/gtp_mme.h> |
Harald Welte | 0b588be | 2018-07-30 18:25:31 +0200 | [diff] [blame] | 13 | #include <osmocom/gsm/oap_client.h> |
Harald Welte | f4b2c4c | 2018-09-16 07:53:41 +0200 | [diff] [blame] | 14 | #include <osmocom/gsupclient/gsup_client.h> |
Neels Hofmeyr | 396f2e6 | 2017-09-04 15:13:25 +0200 | [diff] [blame] | 15 | #include <osmocom/sgsn/common.h> |
Harald Welte | 288be16 | 2010-05-01 16:48:27 +0200 | [diff] [blame] | 16 | |
Pau Espin Pedrol | f44dfa8 | 2023-01-09 13:01:00 +0100 | [diff] [blame] | 17 | #include "../../config.h" |
Neels Hofmeyr | 69e356b | 2018-03-15 13:00:35 +0100 | [diff] [blame] | 18 | |
| 19 | #if BUILD_IU |
| 20 | #include <osmocom/ranap/iu_client.h> |
| 21 | #endif |
| 22 | |
Holger Hans Peter Freyther | 66e7106 | 2015-05-25 01:21:50 +0800 | [diff] [blame] | 23 | #include <ares.h> |
Max | c005db7 | 2017-10-27 18:43:29 +0200 | [diff] [blame] | 24 | #include <gtp.h> |
Holger Hans Peter Freyther | 66e7106 | 2015-05-25 01:21:50 +0800 | [diff] [blame] | 25 | |
Holger Hans Peter Freyther | 39c430e | 2015-05-25 12:26:49 +0800 | [diff] [blame] | 26 | struct hostent; |
Jacob Erlbeck | 39f040d | 2014-12-18 12:46:47 +0100 | [diff] [blame] | 27 | |
Pau Espin Pedrol | 58101ea | 2023-01-09 12:29:27 +0100 | [diff] [blame^] | 28 | #define SGSN_ERROR_CAUSE_NONE (-1) |
| 29 | |
Jacob Erlbeck | 106f547 | 2014-11-04 10:08:37 +0100 | [diff] [blame] | 30 | enum sgsn_auth_policy { |
| 31 | SGSN_AUTH_POLICY_OPEN, |
| 32 | SGSN_AUTH_POLICY_CLOSED, |
Jacob Erlbeck | be2c8d9 | 2014-11-12 10:18:09 +0100 | [diff] [blame] | 33 | SGSN_AUTH_POLICY_ACL_ONLY, |
| 34 | SGSN_AUTH_POLICY_REMOTE |
Jacob Erlbeck | 106f547 | 2014-11-04 10:08:37 +0100 | [diff] [blame] | 35 | }; |
| 36 | |
Alexander Couzens | 14314bd | 2016-07-05 09:52:52 +0200 | [diff] [blame] | 37 | |
| 38 | enum sgsn_rate_ctr_keys { |
Alexander Couzens | 4e699a9 | 2016-07-05 11:04:27 +0200 | [diff] [blame] | 39 | CTR_LLC_DL_BYTES, |
| 40 | CTR_LLC_UL_BYTES, |
| 41 | CTR_LLC_DL_PACKETS, |
| 42 | CTR_LLC_UL_PACKETS, |
Alexander Couzens | 14314bd | 2016-07-05 09:52:52 +0200 | [diff] [blame] | 43 | CTR_GPRS_ATTACH_REQUEST, |
| 44 | CTR_GPRS_ATTACH_ACKED, |
| 45 | CTR_GPRS_ATTACH_REJECTED, |
| 46 | CTR_GPRS_DETACH_REQUEST, |
| 47 | CTR_GPRS_DETACH_ACKED, |
| 48 | CTR_GPRS_ROUTING_AREA_REQUEST, |
| 49 | CTR_GPRS_ROUTING_AREA_ACKED, |
| 50 | CTR_GPRS_ROUTING_AREA_REJECT, |
| 51 | /* PDP single packet counter / GSM 04.08 9.5.1 - 9.5.9 */ |
| 52 | CTR_PDP_ACTIVATE_REQUEST, |
| 53 | CTR_PDP_ACTIVATE_REJECT, |
| 54 | CTR_PDP_ACTIVATE_ACCEPT, |
| 55 | CTR_PDP_REQUEST_ACTIVATE, /* unused */ |
| 56 | CTR_PDP_REQUEST_ACTIVATE_REJ, /* unused */ |
| 57 | CTR_PDP_MODIFY_REQUEST, /* unsued */ |
| 58 | CTR_PDP_MODIFY_ACCEPT, /* unused */ |
| 59 | CTR_PDP_DL_DEACTIVATE_REQUEST, |
| 60 | CTR_PDP_DL_DEACTIVATE_ACCEPT, |
| 61 | CTR_PDP_UL_DEACTIVATE_REQUEST, |
| 62 | CTR_PDP_UL_DEACTIVATE_ACCEPT, |
| 63 | }; |
| 64 | |
Holger Hans Peter Freyther | 4f5b823 | 2015-05-05 22:25:48 +0200 | [diff] [blame] | 65 | struct sgsn_cdr { |
| 66 | char *filename; |
Pau Espin Pedrol | 2e9ea50 | 2017-11-29 14:01:35 +0100 | [diff] [blame] | 67 | bool trap; |
Holger Hans Peter Freyther | 4f5b823 | 2015-05-05 22:25:48 +0200 | [diff] [blame] | 68 | int interval; |
| 69 | }; |
| 70 | |
Harald Welte | 288be16 | 2010-05-01 16:48:27 +0200 | [diff] [blame] | 71 | struct sgsn_config { |
| 72 | /* parsed from config file */ |
Harald Welte | 288be16 | 2010-05-01 16:48:27 +0200 | [diff] [blame] | 73 | |
Harald Welte | 2720e73 | 2010-05-17 00:44:57 +0200 | [diff] [blame] | 74 | char *gtp_statedir; |
| 75 | struct sockaddr_in gtp_listenaddr; |
| 76 | |
Harald Welte | 288be16 | 2010-05-01 16:48:27 +0200 | [diff] [blame] | 77 | /* misc */ |
Alexander Couzens | f23e2db | 2020-07-27 22:39:58 +0200 | [diff] [blame] | 78 | struct gprs_ns2_inst *nsi; |
Harald Welte | 7f6da48 | 2013-03-19 11:00:13 +0100 | [diff] [blame] | 79 | |
Jacob Erlbeck | 106f547 | 2014-11-04 10:08:37 +0100 | [diff] [blame] | 80 | enum sgsn_auth_policy auth_policy; |
Neels Hofmeyr | 340a7e9 | 2022-03-07 15:37:24 +0100 | [diff] [blame] | 81 | uint8_t gea_encryption_mask; |
Neels Hofmeyr | 3c7656a | 2022-03-07 15:38:59 +0100 | [diff] [blame] | 82 | uint8_t uea_encryption_mask; |
Harald Welte | 7f6da48 | 2013-03-19 11:00:13 +0100 | [diff] [blame] | 83 | struct llist_head imsi_acl; |
Jacob Erlbeck | 39f040d | 2014-12-18 12:46:47 +0100 | [diff] [blame] | 84 | |
| 85 | struct sockaddr_in gsup_server_addr; |
| 86 | int gsup_server_port; |
Jacob Erlbeck | 9d4f46c | 2014-12-17 13:20:08 +0100 | [diff] [blame] | 87 | |
Pau Espin Pedrol | d1463bc | 2019-06-13 19:03:25 +0200 | [diff] [blame] | 88 | /* Only meaningful if auth_policy is SGSN_AUTH_POLICY_REMOTE */ |
Jacob Erlbeck | 9d4f46c | 2014-12-17 13:20:08 +0100 | [diff] [blame] | 89 | int require_authentication; |
Pau Espin Pedrol | d1463bc | 2019-06-13 19:03:25 +0200 | [diff] [blame] | 90 | |
Jacob Erlbeck | 771573c | 2014-12-19 18:08:48 +0100 | [diff] [blame] | 91 | int require_update_location; |
Holger Hans Peter Freyther | 4f5b823 | 2015-05-05 22:25:48 +0200 | [diff] [blame] | 92 | |
| 93 | /* CDR configuration */ |
| 94 | struct sgsn_cdr cdr; |
Holger Hans Peter Freyther | 39c430e | 2015-05-25 12:26:49 +0800 | [diff] [blame] | 95 | |
Pau Espin Pedrol | a299d65 | 2019-08-14 19:11:10 +0200 | [diff] [blame] | 96 | /* Timer defintions */ |
| 97 | struct osmo_tdef *T_defs; |
Pau Espin Pedrol | 8501126 | 2022-11-02 20:23:09 +0100 | [diff] [blame] | 98 | struct osmo_tdef *T_defs_gtp; |
Harald Welte | 9450882 | 2015-08-15 19:08:21 +0200 | [diff] [blame] | 99 | |
Holger Hans Peter Freyther | 39c430e | 2015-05-25 12:26:49 +0800 | [diff] [blame] | 100 | int dynamic_lookup; |
Neels Hofmeyr | 9c534fd | 2015-10-12 11:57:37 +0200 | [diff] [blame] | 101 | |
Harald Welte | 0b588be | 2018-07-30 18:25:31 +0200 | [diff] [blame] | 102 | struct osmo_oap_client_config oap; |
Philipp | f1f3436 | 2016-08-26 17:00:21 +0200 | [diff] [blame] | 103 | |
| 104 | /* RFC1144 TCP/IP header compression */ |
| 105 | struct { |
| 106 | int active; |
| 107 | int passive; |
| 108 | int s01; |
| 109 | } pcomp_rfc1144; |
Philipp | 73f83d5 | 2016-09-02 13:38:01 +0200 | [diff] [blame] | 110 | |
| 111 | /* V.42vis data compression */ |
| 112 | struct { |
| 113 | int active; |
| 114 | int passive; |
| 115 | int p0; |
| 116 | int p1; |
| 117 | int p2; |
| 118 | } dcomp_v42bis; |
Neels Hofmeyr | 2188a77 | 2016-05-20 21:59:55 +0200 | [diff] [blame] | 119 | |
Neels Hofmeyr | 69e356b | 2018-03-15 13:00:35 +0100 | [diff] [blame] | 120 | #if BUILD_IU |
Neels Hofmeyr | 2188a77 | 2016-05-20 21:59:55 +0200 | [diff] [blame] | 121 | struct { |
Neels Hofmeyr | 69e356b | 2018-03-15 13:00:35 +0100 | [diff] [blame] | 122 | enum ranap_nsap_addr_enc rab_assign_addr_enc; |
Pau Espin Pedrol | 2c90899 | 2019-08-19 19:06:06 +0200 | [diff] [blame] | 123 | uint32_t cs7_instance; |
Neels Hofmeyr | 2188a77 | 2016-05-20 21:59:55 +0200 | [diff] [blame] | 124 | } iu; |
Neels Hofmeyr | 69e356b | 2018-03-15 13:00:35 +0100 | [diff] [blame] | 125 | #endif |
Stefan Sperling | 8822009 | 2018-12-11 14:42:00 +0100 | [diff] [blame] | 126 | |
| 127 | /* This is transmitted as IPA Serial Number tag, which is used for GSUP routing (e.g. in OsmoHLR). |
| 128 | * This name must be set in a multi-SGSN network, and it must be unique to each SGSN. |
| 129 | * If no name is set, the IPA Serial Number will be the same as the Unit Name, |
| 130 | * and will be of the form 'SGSN-00-00-00-00-00-00' */ |
| 131 | char *sgsn_ipa_name; |
Harald Welte | 288be16 | 2010-05-01 16:48:27 +0200 | [diff] [blame] | 132 | }; |
| 133 | |
Harald Welte | 2720e73 | 2010-05-17 00:44:57 +0200 | [diff] [blame] | 134 | struct sgsn_instance { |
| 135 | char *config_file; |
| 136 | struct sgsn_config cfg; |
| 137 | /* File descriptor wrappers for LibGTP */ |
Pablo Neira Ayuso | 4db9299 | 2011-05-06 12:11:23 +0200 | [diff] [blame] | 138 | struct osmo_fd gtp_fd0; |
| 139 | struct osmo_fd gtp_fd1c; |
| 140 | struct osmo_fd gtp_fd1u; |
Harald Welte | 2720e73 | 2010-05-17 00:44:57 +0200 | [diff] [blame] | 141 | /* GSN instance for libgtp */ |
| 142 | struct gsn_t *gsn; |
Jacob Erlbeck | 39f040d | 2014-12-18 12:46:47 +0100 | [diff] [blame] | 143 | /* Subscriber */ |
Harald Welte | f4b2c4c | 2018-09-16 07:53:41 +0200 | [diff] [blame] | 144 | struct osmo_gsup_client *gsup_client; |
Jacob Erlbeck | 81ffb74 | 2015-01-23 11:33:51 +0100 | [diff] [blame] | 145 | /* LLME inactivity timer */ |
| 146 | struct osmo_timer_list llme_timer; |
Holger Hans Peter Freyther | 66e7106 | 2015-05-25 01:21:50 +0800 | [diff] [blame] | 147 | |
| 148 | /* c-ares event loop integration */ |
| 149 | struct osmo_timer_list ares_timer; |
| 150 | struct llist_head ares_fds; |
| 151 | ares_channel ares_channel; |
Holger Hans Peter Freyther | a5a6da4 | 2015-05-25 15:20:27 +0800 | [diff] [blame] | 152 | struct ares_addr_node *ares_servers; |
Alexander Couzens | 14314bd | 2016-07-05 09:52:52 +0200 | [diff] [blame] | 153 | |
| 154 | struct rate_ctr_group *rate_ctrs; |
Pau Espin Pedrol | e5c8998 | 2021-05-03 18:16:42 +0200 | [diff] [blame] | 155 | |
Pau Espin Pedrol | fd4d435 | 2023-01-05 19:37:05 +0100 | [diff] [blame] | 156 | struct llist_head apn_list; /* list of struct sgsn_apn_ctx */ |
Pau Espin Pedrol | 44bde6b | 2023-01-05 17:23:26 +0100 | [diff] [blame] | 157 | struct llist_head ggsn_list; /* list of struct sgsn_ggsn_ctx */ |
Pau Espin Pedrol | e5c8998 | 2021-05-03 18:16:42 +0200 | [diff] [blame] | 158 | struct llist_head mme_list; /* list of struct sgsn_mme_ctx */ |
Pau Espin Pedrol | 15a52d9 | 2023-01-05 20:26:31 +0100 | [diff] [blame] | 159 | struct llist_head pdp_list; /* list of struct sgsn_pdp_ctx */ |
Pau Espin Pedrol | e659f75 | 2023-01-05 17:20:37 +0100 | [diff] [blame] | 160 | |
| 161 | struct ctrl_handle *ctrlh; |
Harald Welte | 2720e73 | 2010-05-17 00:44:57 +0200 | [diff] [blame] | 162 | }; |
| 163 | |
Harald Welte | 8fc1a46 | 2010-05-17 00:53:10 +0200 | [diff] [blame] | 164 | extern struct sgsn_instance *sgsn; |
Pau Espin Pedrol | 164a1ee | 2023-01-11 12:42:31 +0100 | [diff] [blame] | 165 | extern void *tall_sgsn_ctx; |
Harald Welte | 288be16 | 2010-05-01 16:48:27 +0200 | [diff] [blame] | 166 | |
Pau Espin Pedrol | fd9e82d | 2023-01-09 12:00:17 +0100 | [diff] [blame] | 167 | /* |
| 168 | * ctrl interface related work (sgsn_ctrl.c) |
| 169 | */ |
| 170 | int sgsn_ctrl_cmds_install(void); |
| 171 | |
Harald Welte | 288be16 | 2010-05-01 16:48:27 +0200 | [diff] [blame] | 172 | /* sgsn_vty.c */ |
| 173 | |
Neels Hofmeyr | c9a352f | 2017-07-20 14:41:20 +0200 | [diff] [blame] | 174 | int sgsn_vty_init(struct sgsn_config *cfg); |
| 175 | int sgsn_parse_config(const char *config_file); |
Max | c005db7 | 2017-10-27 18:43:29 +0200 | [diff] [blame] | 176 | char *sgsn_gtp_ntoa(struct ul16_t *ul); |
Harald Welte | 288be16 | 2010-05-01 16:48:27 +0200 | [diff] [blame] | 177 | |
| 178 | /* sgsn.c */ |
Pau Espin Pedrol | e659f75 | 2023-01-05 17:20:37 +0100 | [diff] [blame] | 179 | struct sgsn_instance *sgsn_instance_alloc(void *talloc_ctx); |
| 180 | int sgsn_inst_init(struct sgsn_instance *sgsn); |
Holger Hans Peter Freyther | 4f5b823 | 2015-05-05 22:25:48 +0200 | [diff] [blame] | 181 | /* |
| 182 | * CDR related functionality |
| 183 | */ |
| 184 | int sgsn_cdr_init(struct sgsn_instance *sgsn); |
Pau Espin Pedrol | e659f75 | 2023-01-05 17:20:37 +0100 | [diff] [blame] | 185 | void sgsn_cdr_release(struct sgsn_instance *sgsn); |
Holger Hans Peter Freyther | 4f5b823 | 2015-05-05 22:25:48 +0200 | [diff] [blame] | 186 | |
Holger Hans Peter Freyther | 66e7106 | 2015-05-25 01:21:50 +0800 | [diff] [blame] | 187 | |
| 188 | /* |
| 189 | * C-ARES related functionality |
| 190 | */ |
| 191 | int sgsn_ares_init(struct sgsn_instance *sgsn); |
| 192 | int sgsn_ares_query(struct sgsn_instance *sgsm, const char *name, ares_host_callback cb, void *data); |
| 193 | |
Harald Welte | 288be16 | 2010-05-01 16:48:27 +0200 | [diff] [blame] | 194 | #endif |