- implemented sa_config

- uses identification - and host - untested - ts need further tuning
2005-12-01 07:35:03 +00:00
parent 2ef11339c7
commit d45ec1dedf
12 changed files with 1040 additions and 68 deletions
@@ -0,0 +1,114 @@
+/**
+ * @file identification.h
+ *
+ * @brief Interface of identification_t.
+ *
+ */
+
+/*
+ * Copyright (C) 2005 Jan Hutter, Martin Willi
+ * Hochschule fuer Technik Rapperswil
+ *
+ * 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.  See <http://www.fsf.org/copyleft/gpl.txt>.
+ *
+ * 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.
+ */
+
+
+#ifndef _IDENTIFICATION_H_
+#define _IDENTIFICATION_H_
+
+
+#include "types.h"
+
+#include <encoding/payloads/id_payload.h>
+
+typedef struct identification_t identification_t;
+
+/**
+ * @brief Generic identification, such as used in ID payload.
+ * 
+ * The following types are possible:
+ * 
+ * - ID_IPV4_ADDR 
+ * - ID_FQDN (not implemented)
+ * - ID_RFC822_ADDR  (not implemented)
+ * - ID_IPV6_ADDR (not implemented)
+ * - ID_DER_ASN1_DN  (not implemented)
+ * - ID_DER_ASN1_GN (not implemented)
+ * - ID_KEY_ID (not implemented)
+ *
+ * @ingroup sa
+ */
+struct identification_t {
+	
+	/**
+	 * @brief Get the encoding of this id, to send over
+	 * the network.
+	 * 
+	 * @warning Result points to internal data, do NOT free!
+	 * 
+	 * @param this		the identification_t_object
+	 * @return 			a chunk containing the encoded bytes
+	 */
+	chunk_t (*get_encoding) (identification_t *this);
+	
+	/**
+	 * @brief Get the type of this identification.
+	 * 
+	 * @param this		the identification_t_object
+	 * @return 			id_type_t
+	 */
+	id_type_t (*get_type) (identification_t *this);
+	
+	/**
+	 * @brief Get a string representation of this id.
+	 * 
+	 * @warning Result points to internal data, do NOT free!
+	 * 
+	 * @param this		the identification_t_object
+	 * @return 			string
+	 */
+	char *(*get_string) (identification_t *this);
+
+	/**
+	 * @brief Destroys a identification_t object.
+	 *
+	 * @param this 				identification_t object
+	 */
+	void (*destroy) (identification_t *this);
+};
+
+/**
+ * @brief Creates an identification_t object from a string.
+ * 
+ * @param type		type of this id, such as ID_IPV4_ADDR or ID_RFC822_ADDR
+ * @param string	input string, which will be converted
+ * @return			- created identification_t object, or
+ * 					- NULL if type not supported.
+ * 
+ * @ingroup sa
+ */
+identification_t * identification_create_from_string(id_type_t type, char *string);
+
+
+/**
+ * @brief Creates an identification_t object from an encoded chunk.
+ * 
+ * @param type		type of this id, such as ID_IPV4_ADDR or ID_RFC822_ADDR
+ * @param encoded	encoded bytes, such as from identification_t.get_encoding
+ * @return			- created identification_t object, or
+ * 					- NULL if type not supported.
+ * 
+ * @ingroup sa
+ */
+identification_t * identification_create_from_encoding(id_type_t type, chunk_t encoded);
+
+
+#endif //_IDENTIFICATION_H_