sergiotarxz/nuttx-apps
sergiotarxz/nuttx-apps
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Add the beginnings of an FTP server

Browse Source 
git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@4368 42af7a65-404d-4744-a932-0658087f49c3
This commit is contained in:
patacongo 2012-02-04 21:02:45 +00:00
parent 8c4b8c77fa
commit eeff74085e
5 changed files with 4990 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
ChangeLog.txt
View File

@ -180,4 +180,8 @@
* apps/system/readline: Moved the old nuttx/lib/stdio/lib_fgets.c here
and renamed it as readline(). The old fgets was simplied and the overloaded
readline functionality was removed.
* apps/netutils/ftpd: Add an FTPD server (does not even compile on initial
checkin).
* apps/examples/ftpd: Add a test for the FTPD server (untest on initial
check-in).

72
examples/ftpd/ftpd_main.c Executable file
View File

@ -0,0 +1,72 @@
#include "ftpd.h"
struct fptd_account_s
{
uint8_t flags;
FAR const char *user;
FAR const char *password;
FAR const char *home;
}
static const struct fptd_account_s g_ftpdaccounts[] =
{
{ FTPD_ACCOUNTFLAG_SYSTEM, "root", "abc123", NULL) },
{ FTPD_ACCOUNTFLAG_GUEST, "ftp", NULL, NULL },
{ FTPD_ACCOUNTFLAG_GUEST, "anonymous", NULL, NULL },
};
#define NACCOUNTS (sizeof(g_ftpdaccounts) / sizeof(struct fptd_account_s))
static void ftpd_accounts(FTPD_SESSION handle)
{
FAR onst struct fptd_account_s *account;
int i;
for (i = 0; i < NACCOUNTS; i++)
{
account = &g_ftpdaccounts[i];
ftpd_add_user(handle, account->flags, account->user, account->password, account->home);
}
}
int ftpd_main(int s_argc, char **s_argv)
{
FTPD_SESSION handle;
int ret;
/* Bring up the network */
ret = ftpd_netinit();
if (ret < 0)
{
ndbg("Failed to initialize the network\n");
return EXIT_FAILURE;
}
/* Open FTPD */
handle = ftpd_open();
if (!handle)
{
ndbg("Failed to open FTPD\n");
return EXIT_FAILURE;
}
/* Configure acounts */
(void)ftpd_accounts(handle);
/* Then drive the FTPD server */
while (g_ftpd_break == 0)
{
(void)ftpd_run(handle, 1000);
}
/* Close the FTPD server and exit */
ftpd_close(handle);
return EXIT_SUCCESS;
}
/* vim: set expandtab: */
/* End of source */

187
include/netutils/ftpd.h Executable file
View File

@ -0,0 +1,187 @@
/****************************************************************************
* apps/include/netutils/ftpd.h
*
* Copyright (C) 2012 Gregory Nutt. All rights reserved.
* Author: Gregory Nutt <spudmonkey@racsa.co.cr>
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* 3. Neither the name NuttX nor the names of its contributors may be
* used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
****************************************************************************/
#ifndef __APPS_INCLUDE_NETUTILS_FTPD_H
#define __APPS_INCLUDE_NETUTILS_FTPD_H
/****************************************************************************
* Included Files
****************************************************************************/
#include <nuttx/config.h>
#include <stdint.h>
/****************************************************************************
* Pre-processor Definitions
****************************************************************************/
/* Configuration ************************************************************/
#ifdef CONFIG_DISABLE_PTHREAD
# error "pthread support is required (CONFIG_DISABLE_PTHREAD=n)"
#endif
#ifndef CONFIG_FTPD_VENDORID
# define CONFIG_FTPD_VENDORID "NuttX"
#endif
#ifndef CONFIG_FTPD_SERVERID
# define CONFIG_FTPD_SERVERID "NuttX FTP Server"
#endif
#ifndef CONFIG_FTPD_CMDBUFFERSIZE
# define CONFIG_FTPD_CMDBUFFERSIZE 512
#endif
#ifndef CONFIG_FTPD_DATABUFFERSIZE
# define CONFIG_FTPD_DATABUFFERSIZE 2048
#endif
#ifndef CONFIG_FTPD_WORKERSTACKSIZE
# define CONFIG_FTPD_WORKERSTACKSIZE 2048
#endif
/****************************************************************************
* Public Types
****************************************************************************/
/* This "handle" describes the FTP session */
typedef FAR void *FTPD_SESSION;
/****************************************************************************
* Public Data
****************************************************************************/
#ifdef __cplusplus
#define EXTERN extern "C"
extern "C" {
#else
#define EXTERN extern
#endif
/****************************************************************************
* Public Functions
****************************************************************************/
/****************************************************************************
* Name: ftpd_open
*
* Description:
* Create an instance of the FTPD server and return a handle that can be
* used to run the server.
*
* Input Parameters:
* None
*
* Returned Value:
* On success, a non-NULL handle is returned that can be used to reference
* the server instance.
*
****************************************************************************/
EXTERN FTPD_SESSION ftpd_open(void);
/****************************************************************************
* Name: ftpd_adduser
*
* Description:
* Add one FTP user.
*
* Input Parameters:
* handle - A handle previously returned by ftpd_open
* accountflags - The characteristics of this user (see FTPD_ACCOUNTFLAGS_*
* defintiions.
* user - The user login name. May be NULL indicating that no login is
* required.
* passwd - The user password. May be NULL indicating that no password
* is required.
* home - The user home directory. May be NULL.
*
* Returned Value:
* Zero is returned on success. A negated errno value is return on
* failure.
*
****************************************************************************/
EXTERN int ftpd_adduser(FTPD_SESSION handle, uint8_t accountflags,
FAR const char *user, FAR const char *passwd,
FAR const char *home);
/****************************************************************************
* Name: ftpd_session
*
* Description:
* Execute the FTPD server. This thread does not return until either (1)
* the timeout expires with no connection, (2) some other error occurs, or
* (2) a connection was accepted and an FTP worker thread was started to
* service the session. Each call to ftpd_session creates on session.
*
* Input Parameters:
* handle - A handle previously returned by ftpd_open
* timeout - A time in milliseconds to wait for a connection. If this
* time elapses with no connected, the -ETIMEDOUT error will be returned.
*
* Returned Value:
* Zero is returned if the FTP worker was started. On failure, a negated
* errno value is returned to indicate why the servier terminated.
* -ETIMEDOUT indicates that the user-provided timeout elapsed with no
* connection.
*
****************************************************************************/
EXTERN int ftpd_session(FTPD_SESSION handle, int timeout);
/****************************************************************************
* Name: ftpd_close
*
* Description:
* Close and destroy the handle created by ftpd_open.
*
* Input Parameters:
* handle - A handle previously returned by ftpd_open
*
* Returned Value:
* None
*
****************************************************************************/
EXTERN void ftpd_close(FTPD_SESSION handle);
#undef EXTERN
#ifdef __cplusplus
}
#endif
#endif /* __APPS_INCLUDE_NETUTILS_FTPD_H */

4523
netutils/ftpd/ftpd.c Executable file
View File

File diff suppressed because it is too large Load Diff

204
netutils/ftpd/ftpd.h Executable file
View File

@ -0,0 +1,204 @@
/****************************************************************************
* apps/include/ftpd.h
*
* Copyright (C) 2012 Gregory Nutt. All rights reserved.
* Author: Gregory Nutt <spudmonkey@racsa.co.cr>
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* 3. Neither the name NuttX nor the names of its contributors may be
* used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
****************************************************************************/
#ifndef __APPS_NETUTILS_FTPD_FTPD_H
#define __APPS_NETUTILS_FTPD_FTPD_H
/****************************************************************************
* Included Files
****************************************************************************/
#include <nuttx/config.h>
#include <sys/types.h>
#include <stdbool.h>
#include <netinet/in.h>
/****************************************************************************
* Pre-processor Definitions
****************************************************************************/
/* FPTD Definitions *********************************************************/
# define FTPD_ACCOUNTFLAG_NONE (0)
# define FTPD_ACCOUNTFLAG_ADMIN (1 << 0)
# define FTPD_ACCOUNTFLAG_SYSTEM (1 << 1)
# define FTPD_ACCOUNTFLAG_GUEST (1 << 2)
# define FTPD_SESSIONFLAG_USER (1 << 0)
# define FTPD_SESSIONFLAG_RESTARTPOS (1 << 1)
# define FTPD_SESSIONFLAG_RENAMEFROM (1 << 2)
# define FTPD_LISTOPTION_A (1 << 0)
# define FTPD_LISTOPTION_L (1 << 1)
# define FTPD_LISTOPTION_F (1 << 2)
# define FTPD_LISTOPTION_R (1 << 3)
# define FTPD_LISTOPTION_UNKNOWN (1 << 7)
# define FTPD_CMDFLAG_LOGIN (1 << 0)
/****************************************************************************
* Public Types
****************************************************************************/
/* This enumerates the type of each session */
enum ftpd_sessiontype_e
{
FTPD_SESSIONTYPE_NONE = 0
FTPD_SESSIONTYPE_A,
FTPD_SESSIONTYPE_I,
FTPD_SESSIONTYPE_L8
};
typedef struct ftpd_pathnode_s
{
struct ftpd_pathnode_s *flink;
struct ftpd_pathnode_s *blink;
bool ignore;
FAR char *name;
};
union ftpd_sockaddr_u
{
uint8_t raw[sizeof(struct sockaddr_storage)];
struct sockaddr_storage ss;
struct sockaddr sa;
#ifdef CONFIG_NET_IPv6
struct sockaddr_in6 in6;
#else
struct sockaddr_in in4;
#endif
};
/* This structure describes on account */
struct ftpd_account_s
{
struct ftpd_account_s *blink;
struct ftpd_account_s *flink;
uint8_t flags; /* See FTPD_ACCOUNTFLAG_* definitions */
FAR char *user; /* User name */
FAR char *password; /* Un-encrypted password */
FAR char *home; /* Home directory path */
};
/* This structures describes an FTP session a list of associated accounts */
struct ftpd_server_s
{
int sd; /* Listen socket descriptor */
union ftpd_sockaddr_u addr; /* Listen address */
struct ftpd_account_s *head; /* Head of a list of accounts */
struct ftpd_account_s *tail; /* Tail of a list of accounts */
};
struct ftpd_stream_s
{
int sd; /* Socket descriptor */
union ftpd_sockaddr_u addr; /* Network address */
socklen_t addrlen; /* Length of the address */
size_t buflen; /* Length of the buffer */
uint8_t *buffer; /* Pointer to the buffer */
};
struct ftpd_session_s
{
FAR struct ftpd_server_s shadow;
FAR struct ftpd_account_s *head;
FAR struct ftpd_account_s *curr;
uint8_t flags; /* See TPD_SESSIONFLAG_* definitions */
int txtimeout;
int txtimeout;
/* Command */
struct ftpd_stream_s cmd;
FAR char *cmd;
FAR char *param;
/* Data */
struct ftpd_stream_s data;
off_t restartpos;
/* File */
int fd;
/* Current user */
FAR char *user;
uint8_t m_type; /* See enum ftpd_sessiontype_e */
FAR char *home;
FAR char *work;
FAR char *renamefrom;
};
typedef int (*ftpd_cmdhandler_t)(struct ftpd_session_s *);
struct ftpd_cmd_s
{
FAR const char *cmd; /* The command string */
ftpd_cmdhandler_t handler; /* The function that handles the command */
uint8_t flags; /* See FTPD_CMDFLAGS_* definitions */
};
/* Used to maintain a list of protocol names */
struct ftpd_protocol_s
{
FAR const char *name;
int value;
};
/****************************************************************************
* Public Data
****************************************************************************/
#ifdef __cplusplus
#define EXTERN extern "C"
extern "C" {
#else
#define EXTERN extern
#endif
/****************************************************************************
* Public Functions
****************************************************************************/
#undef EXTERN
#ifdef __cplusplus
}
#endif
#endif /* __APPS_NETUTILS_FTPD_FTPD_H */