Removed len argument from proposal_get_token()
[strongswan.git] / src / libstrongswan / crypto / proposal / proposal_keywords.h
index fb2c846..ad9e82a 100644 (file)
@@ -1,34 +1,69 @@
-/* proposal keywords
- * Copyright (C) 2009 Andreas Steffen
- * Hochschule fuer Technik Rapperswil, Switzerland
+/*
+ * Copyright (c) 2012 Nanoteq Pty Ltd
  *
- * 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>.
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
  *
- * 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.
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+/**
+ * @defgroup proposal_keywords proposal_keywords
+ * @{ @ingroup crypto
  */
 
-#ifndef _PROPOSAL_KEYWORDS_H_
-#define _PROPOSAL_KEYWORDS_H_
+#ifndef PROPOSAL_KEYWORDS_H_
+#define PROPOSAL_KEYWORDS_H_
 
 #include <crypto/transform.h>
 
 typedef struct proposal_token proposal_token_t;
 
+/**
+ * Class representing a proposal token..
+ */
 struct proposal_token {
-    char             *name;
-    transform_type_t  type;
-       u_int16_t         algorithm;
-    u_int16_t         keysize;
-};
 
-extern const proposal_token_t* proposal_get_token(register const char *str,
-                                                                                                 register unsigned int len);
+       /**
+        * The name of the token.
+        */
+       char *name;
+
+       /**
+        * The type of transform in the token.
+        */
+       transform_type_t type;
 
-#endif /* _PROPOSAL_KEYWORDS_H_ */
+       /**
+        * The IKE id of the algorithm.
+        */
+       u_int16_t algorithm;
+
+       /**
+        * The key size associated with the specific algorithm.
+        */
+       u_int16_t keysize;
+};
+
+/**
+ * Returns a proposal token for the specified string if a token exists.
+ *
+ * @param str          the string containing the name of the token
+ * @return                     proposal_tolen if found otherwise NULL
+ */
+const proposal_token_t* proposal_get_token(const char *str);
 
+#endif /** PROPOSAL_KEYWORDS_H_ @}*/