aboutsummaryrefslogtreecommitdiff
path: root/src/string.c
diff options
context:
space:
mode:
authorAndreas Schneider <asn@cynapses.org>2010-09-06 14:28:38 +0200
committerAndreas Schneider <asn@cynapses.org>2010-09-06 14:28:38 +0200
commitf7842e3a4b9acea2126ff725f993c299aef0e6db (patch)
tree18239f819a5edbcfc7f2961c48f3f9297314ef22 /src/string.c
parent38421403d2dc45636e597f2a909daa6ae31976de (diff)
downloadlibssh-f7842e3a4b9acea2126ff725f993c299aef0e6db.tar.gz
libssh-f7842e3a4b9acea2126ff725f993c299aef0e6db.tar.xz
libssh-f7842e3a4b9acea2126ff725f993c299aef0e6db.zip
misc: Rename libssh/ to src/
Diffstat (limited to 'src/string.c')
-rw-r--r--src/string.c212
1 files changed, 212 insertions, 0 deletions
diff --git a/src/string.c b/src/string.c
new file mode 100644
index 00000000..06042aea
--- /dev/null
+++ b/src/string.c
@@ -0,0 +1,212 @@
+/*
+ * string.c - ssh string functions
+ *
+ * This file is part of the SSH Library
+ *
+ * Copyright (c) 2003-2008 by Aris Adamantiadis
+ *
+ * The SSH Library is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; either version 2.1 of the License, or (at your
+ * option) any later version.
+ *
+ * The SSH Library 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 Lesser General Public
+ * License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with the SSH Library; see the file COPYING. If not, write to
+ * the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
+ * MA 02111-1307, USA.
+ */
+
+#include <stdlib.h>
+#include <string.h>
+
+#ifndef _WIN32
+#include <arpa/inet.h>
+#endif
+
+#include "libssh/priv.h"
+#include "libssh/string.h"
+
+/**
+ * @defgroup libssh_string The SSH string functions
+ * @ingroup libssh
+ *
+ * @brief String manipulations used in libssh.
+ *
+ * @{
+ */
+
+/**
+ * @brief Create a new SSH String object.
+ *
+ * @param[in] size The size of the string.
+ *
+ * @return The newly allocated string, NULL on error.
+ */
+struct ssh_string_struct *ssh_string_new(size_t size) {
+ struct ssh_string_struct *str = NULL;
+
+ str = malloc(size + 4);
+ if (str == NULL) {
+ return NULL;
+ }
+
+ str->size = htonl(size);
+ return str;
+}
+
+/**
+ * @brief Fill a string with given data. The string should be big enough.
+ *
+ * @param s An allocated string to fill with data.
+ *
+ * @param data The data to fill the string with.
+ *
+ * @param len Size of data.
+ *
+ * @return 0 on success, < 0 on error.
+ */
+int ssh_string_fill(struct ssh_string_struct *s, const void *data, size_t len) {
+ if ((s == NULL) || (data == NULL) ||
+ (len == 0) || (len > s->size)) {
+ return -1;
+ }
+
+ memcpy(s->string, data, len);
+ return 0;
+}
+
+/**
+ * @brief Create a ssh string using a C string
+ *
+ * @param[in] what The source 0-terminated C string.
+ *
+ * @return The newly allocated string, NULL on error with errno
+ * set.
+ *
+ * @note The nul byte is not copied nor counted in the ouput string.
+ */
+struct ssh_string_struct *ssh_string_from_char(const char *what) {
+ struct ssh_string_struct *ptr = NULL;
+ size_t len = strlen(what);
+
+ ptr = malloc(4 + len);
+ if (ptr == NULL) {
+ return NULL;
+ }
+ ptr->size = htonl(len);
+ memcpy(ptr->string, what, len);
+
+ return ptr;
+}
+
+/**
+ * @brief Return the size of a SSH string.
+ *
+ * @param[in] s The the input SSH string.
+ *
+ * @return The size of the content of the string, 0 on error.
+ */
+size_t ssh_string_len(struct ssh_string_struct *s) {
+ if (s == NULL) {
+ return ntohl(0);
+ }
+
+ return ntohl(s->size);
+}
+
+/**
+ * @brief Convert a SSH string to a C nul-terminated string.
+ *
+ * @param[in] s The SSH input string.
+ *
+ * @return An allocated string pointer, NULL on error with errno
+ * set.
+ *
+ * @note If the input SSH string contains zeroes, some parts of the output
+ * string may not be readable with regular libc functions.
+ */
+char *ssh_string_to_char(struct ssh_string_struct *s) {
+ size_t len = ntohl(s->size) + 1;
+ char *new = malloc(len);
+
+ if (new == NULL) {
+ return NULL;
+ }
+ memcpy(new, s->string, len - 1);
+ new[len - 1] = '\0';
+ return new;
+}
+
+/**
+ * @brief Deallocate a char string object.
+ *
+ * @param[in] s The string to delete.
+ */
+void ssh_string_free_char(char *s) {
+ SAFE_FREE(s);
+}
+
+/**
+ * @brief Copy a string, return a newly allocated string. The caller has to
+ * free the string.
+ *
+ * @param[in] s String to copy.
+ *
+ * @return Newly allocated copy of the string, NULL on error.
+ */
+struct ssh_string_struct *ssh_string_copy(struct ssh_string_struct *s) {
+ struct ssh_string_struct *new = malloc(ntohl(s->size) + 4);
+
+ if (new == NULL) {
+ return NULL;
+ }
+ new->size = s->size;
+ memcpy(new->string, s->string, ntohl(s->size));
+
+ return new;
+}
+
+/**
+ * @brief Destroy the data in a string so it couldn't appear in a core dump.
+ *
+ * @param[in] s The string to burn.
+ */
+void ssh_string_burn(struct ssh_string_struct *s) {
+ if (s == NULL) {
+ return;
+ }
+ memset(s->string, 'X', ssh_string_len(s));
+}
+
+/**
+ * @brief Get the payload of the string.
+ *
+ * @param s The string to get the data from.
+ *
+ * @return Return the data of the string or NULL on error.
+ */
+void *ssh_string_data(struct ssh_string_struct *s) {
+ if (s == NULL) {
+ return NULL;
+ }
+
+ return s->string;
+}
+
+/**
+ * @brief Deallocate a SSH string object.
+ *
+ * \param[in] s The SSH string to delete.
+ */
+void ssh_string_free(struct ssh_string_struct *s) {
+ SAFE_FREE(s);
+}
+
+/** @} */
+
+/* vim: set ts=4 sw=4 et cindent: */