import gprs_gsup_message.[ch] from openbsc as gsup.[ch]

Move those routines from OpenBSC to libosmogsm, so they can be
re-used from other programs.  I think it was a mistake to add them only
inside the openbsc repository in the first place.  We need to pay more
attention to this in the future.

1 files changed, 139 insertions, 0 deletions

diff --git a/include/osmocom/gsm/gsup.h b/include/osmocom/gsm/gsup.h
new file mode 100644
index 00000000..d966b2d2
--- /dev/null
+++ b/include/osmocom/gsm/gsup.h
@@ -0,0 +1,139 @@
+/* Osmocom Subscriber Update Protocol message encoder/decoder */
+
+/* (C) 2014 by Sysmocom s.f.m.c. GmbH, Author: Jacob Erlbeck
+ * (C) 2016 by Harald Welte <laforge@gnumonks.org>
+ * All Rights Reserved
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+#pragma once
+
+#include <stdint.h>
+#include <osmocom/core/msgb.h>
+#include <osmocom/gsm/protocol/gsm_23_003.h>
+#include <osmocom/gsm/protocol/gsm_04_08_gprs.h>
+#include <osmocom/crypt/auth.h>
+
+/*! Maximum nubmer of PDP inside \ref osmo_gsup_message */
+#define OSMO_GSUP_MAX_NUM_PDP_INFO		10 /* GSM 09.02 limits this to 50 */
+/*! Maximum number of auth info inside \ref osmo_gsup_message */
+#define OSMO_GSUP_MAX_NUM_AUTH_INFO		5
+/*! Maximum number of octets encoding MSISDN in BCD format */
+#define OSMO_GSUP_MAX_MSISDN_LEN		9
+
+#define OSMO_GSUP_PDP_TYPE_SIZE			2
+
+/*! Information Element Identifiers for GSUP IEs */
+enum osmo_gsup_iei {
+	OSMO_GSUP_IMSI_IE			= 0x01,
+	OSMO_GSUP_CAUSE_IE			= 0x02,
+	OSMO_GSUP_AUTH_TUPLE_IE			= 0x03,
+	OSMO_GSUP_PDP_INFO_COMPL_IE		= 0x04,
+	OSMO_GSUP_PDP_INFO_IE			= 0x05,
+	OSMO_GSUP_CANCEL_TYPE_IE		= 0x06,
+	OSMO_GSUP_FREEZE_PTMSI_IE		= 0x07,
+	OSMO_GSUP_MSISDN_IE			= 0x08,
+	OSMO_GSUP_HLR_NUMBER_IE			= 0x09,
+	OSMO_GSUP_PDP_CONTEXT_ID_IE		= 0x10,
+	OSMO_GSUP_PDP_TYPE_IE			= 0x11,
+	OSMO_GSUP_ACCESS_POINT_NAME_IE		= 0x12,
+	OSMO_GSUP_PDP_QOS_IE			= 0x13,
+	OSMO_GSUP_RAND_IE			= 0x20,
+	OSMO_GSUP_SRES_IE			= 0x21,
+	OSMO_GSUP_KC_IE				= 0x22,
+	/* 3G support */
+	OSMO_GSUP_IK_IE				= 0x23,
+	OSMO_GSUP_CK_IE				= 0x24,
+	OSMO_GSUP_AUTN_IE			= 0x25,
+	OSMO_GSUP_AUTS_IE			= 0x26,
+	OSMO_GSUP_RES_IE			= 0x27,
+};
+
+/*! GSUP message type */
+enum osmo_gsup_message_type {
+	OSMO_GSUP_MSGT_UPDATE_LOCATION_REQUEST	= 0b00000100,
+	OSMO_GSUP_MSGT_UPDATE_LOCATION_ERROR	= 0b00000101,
+	OSMO_GSUP_MSGT_UPDATE_LOCATION_RESULT	= 0b00000110,
+
+	OSMO_GSUP_MSGT_SEND_AUTH_INFO_REQUEST	= 0b00001000,
+	OSMO_GSUP_MSGT_SEND_AUTH_INFO_ERROR	= 0b00001001,
+	OSMO_GSUP_MSGT_SEND_AUTH_INFO_RESULT	= 0b00001010,
+
+	OSMO_GSUP_MSGT_PURGE_MS_REQUEST		= 0b00001100,
+	OSMO_GSUP_MSGT_PURGE_MS_ERROR		= 0b00001101,
+	OSMO_GSUP_MSGT_PURGE_MS_RESULT		= 0b00001110,
+
+	OSMO_GSUP_MSGT_INSERT_DATA_REQUEST	= 0b00010000,
+	OSMO_GSUP_MSGT_INSERT_DATA_ERROR	= 0b00010001,
+	OSMO_GSUP_MSGT_INSERT_DATA_RESULT	= 0b00010010,
+
+	OSMO_GSUP_MSGT_DELETE_DATA_REQUEST	= 0b00010100,
+	OSMO_GSUP_MSGT_DELETE_DATA_ERROR	= 0b00010101,
+	OSMO_GSUP_MSGT_DELETE_DATA_RESULT	= 0b00010110,
+
+	OSMO_GSUP_MSGT_LOCATION_CANCEL_REQUEST	= 0b00011100,
+	OSMO_GSUP_MSGT_LOCATION_CANCEL_ERROR	= 0b00011101,
+	OSMO_GSUP_MSGT_LOCATION_CANCEL_RESULT	= 0b00011110,
+};
+
+#define OSMO_GSUP_IS_MSGT_REQUEST(msgt) (((msgt) & 0b00000011) == 0b00)
+#define OSMO_GSUP_IS_MSGT_ERROR(msgt)   (((msgt) & 0b00000011) == 0b01)
+#define OSMO_GSUP_TO_MSGT_ERROR(msgt)   (((msgt) & 0b11111100) | 0b01)
+
+enum osmo_gsup_cancel_type {
+	OSMO_GSUP_CANCEL_TYPE_UPDATE		= 1, /* on wire: 0 */
+	OSMO_GSUP_CANCEL_TYPE_WITHDRAW		= 2, /* on wire: 1 */
+};
+
+/*! parsed/decoded PDP context information */
+struct osmo_gsup_pdp_info {
+	unsigned int			context_id;
+	int				have_info;
+	/*! Type of PDP context */
+	uint16_t			pdp_type;
+	/*! APN information, still in encoded form. Can be NULL if no
+	 * APN information included */
+	const uint8_t			*apn_enc;
+	/*! length (in octets) of apn_enc */
+	size_t				apn_enc_len;
+	/*! QoS information, still in encoded form. Can be NULL if no
+	 * QoS information included */
+	const uint8_t			*qos_enc;
+	/*! length (in octets) of qos_enc */
+	size_t				qos_enc_len;
+};
+
+/*! parsed/decoded GSUP protocol message */
+struct osmo_gsup_message {
+	enum osmo_gsup_message_type	message_type;
+	char				imsi[GSM23003_IMSI_MAX_DIGITS+2];
+	enum gsm48_gmm_cause		cause;
+	enum osmo_gsup_cancel_type	cancel_type;
+	int				pdp_info_compl;
+	int				freeze_ptmsi;
+	struct osmo_auth_vector		auth_vectors[OSMO_GSUP_MAX_NUM_AUTH_INFO];
+	size_t				num_auth_vectors;
+	struct osmo_gsup_pdp_info	pdp_infos[OSMO_GSUP_MAX_NUM_PDP_INFO];
+	size_t				num_pdp_infos;
+	const uint8_t			*msisdn_enc;
+	size_t				msisdn_enc_len;
+	const uint8_t			*hlr_enc;
+	size_t				hlr_enc_len;
+	const uint8_t			*auts;
+};
+
+int osmo_gsup_decode(const uint8_t *data, size_t data_len,
+		     struct osmo_gsup_message *gsup_msg);
+void osmo_gsup_encode(struct msgb *msg, const struct osmo_gsup_message *gsup_msg);