include/rtems/ftpd.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  *  @file
0005  *
0006  *  @brief FTP Server Information
0007  */
0008
0009 /*
0010  * Copyright (C) 1999 Jake Janovetz <jvanovetz@uiuc.edu>
0011  *
0012  * Redistribution and use in source and binary forms, with or without
0013  * modification, are permitted provided that the following conditions
0014  * are met:
0015  * 1. Redistributions of source code must retain the above copyright
0016  *    notice, this list of conditions and the following disclaimer.
0017  * 2. Redistributions in binary form must reproduce the above copyright
0018  *    notice, this list of conditions and the following disclaimer in the
0019  *    documentation and/or other materials provided with the distribution.
0020  *
0021  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0022  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0023  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0024  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0025  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0026  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0027  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0028  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0029  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0030  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0031  * POSSIBILITY OF SUCH DAMAGE.
0032  */
0033
0034 #ifndef _RTEMS_FTPD_H
0035 #define _RTEMS_FTPD_H
0036
0037 #include <rtems.h>
0038
0039 #ifdef __cplusplus
0040 extern "C" {
0041 #endif
0042
0043 #define FTPD_CONTROL_PORT   21
0044
0045 /* Various buffer sizes */
0046 enum {
0047   FTPD_BUFSIZE  = 256,       /* Size for temporary buffers */
0048   FTPD_DATASIZE = 4 * 1024,      /* Size for file transfer buffers */
0049   FTPD_STACKSIZE = RTEMS_MINIMUM_STACK_SIZE + FTPD_DATASIZE /* Tasks stack size */
0050 };
0051
0052 /* FTPD access control flags */
0053 enum
0054 {
0055   FTPD_NO_WRITE = 0x1,
0056   FTPD_NO_READ  = 0x2,
0057   FTPD_NO_RW    = FTPD_NO_WRITE | FTPD_NO_READ
0058 };
0059
0060 typedef int (*rtems_ftpd_hookfunction)(char *, size_t);
0061
0062 #include <rtems/shell.h>
0063
0064 struct rtems_ftpd_hook
0065 {
0066    char                    *filename;
0067    rtems_ftpd_hookfunction hook_function;
0068 };
0069
0070 struct rtems_ftpd_configuration
0071 {
0072    rtems_task_priority     priority;           /* FTPD task priority  */
0073    unsigned long           max_hook_filesize;  /* Maximum buffersize  */
0074                                                /*    for hooks        */
0075    int                     port;               /* Well-known port     */
0076    struct rtems_ftpd_hook  *hooks;             /* List of hooks       */
0077    char const              *root;              /* Root for FTPD or 0 for / */
0078    int                     tasks_count;        /* Max. connections    */
0079    int                     idle;               /* Idle timeout in seoconds
0080                                                   or 0 for no (inf) timeout */
0081    int                     access;             /* 0 - r/w, 1 - read-only,
0082                                                   2 - write-only,
0083                                                   3 - browse-only */
0084    rtems_shell_login_check_t login;            /* Login check or 0 to ignore
0085                                                   user/passwd. */
0086    bool                    verbose;            /* Say hello! */
0087 };
0088
0089 rtems_status_code rtems_ftpd_start(
0090   const struct rtems_ftpd_configuration *config
0091 );
0092
0093 extern struct rtems_ftpd_configuration rtems_ftpd_configuration;
0094
0095 rtems_status_code rtems_initialize_ftpd(void);
0096
0097 #ifdef __cplusplus
0098 }
0099 #endif
0100
0101 #endif  /* _RTEMS_FTPD_H */