command_util.sh: Make it read the function prototype from the source file
[paraslash.git] / command.c
index 928990e6911a8cb5b52b2a0ed6f3aea41bf611e1..d0d9047b7d3d97dc1061a6c52db158e500d4969c 100644 (file)
--- a/command.c
+++ b/command.c
@@ -43,7 +43,6 @@ extern struct misc_meta_data *mmd;
 extern struct audio_file_selector selectors[];
 extern struct sender senders[];
 extern char *user_list;
-struct sockaddr_in *in_addr;
 
 static void dummy(__a_unused int s)
 {}
@@ -72,7 +71,7 @@ static char *vss_status_tohuman(unsigned int flags)
 /*
  * return human readable permission string. Never returns NULL.
  */
-char *cmd_perms_itohuman(unsigned int perms)
+static char *cmd_perms_itohuman(unsigned int perms)
 {
        char *msg = para_malloc(5 * sizeof(char));
 
@@ -102,7 +101,7 @@ static char *vss_get_status_flags(unsigned int flags)
 /*
  * compute status bar string. Never returns NULL
  */
-char *get_sb_string(struct misc_meta_data *nmmd)
+static char *get_sb_string(struct misc_meta_data *nmmd)
 {
        char *base, *ret;
        long long unsigned secs = 0, rsecs = 0, percent = 0;
@@ -342,20 +341,18 @@ int com_si(int fd, int argc, __a_unused char **argv)
 }
 
 /* version */
-int com_version(int socket_fd, int argc, __a_unused char **argv)
+int com_version(int fd, int argc, __a_unused char **argv)
 {
        if (argc != 1)
                return -E_COMMAND_SYNTAX;
-       return send_buffer(socket_fd, "para_server-" PACKAGE_VERSION ", \""
-                       CODENAME "\"\n"
-                       COPYRIGHT "\n"
-                       "built: " BUILD_DATE "\n"
-                       SYSTEM ", " CC_VERSION "\n"
-               );
+       return send_buffer(fd, VERSION_TEXT("server")
+               "built: " BUILD_DATE "\n"
+               SYSTEM ", " CC_VERSION "\n"
+       );
 }
 
 /* sc */
-int com_sc(int socket_fd, int argc, char **argv)
+int com_sc(int fd, int argc, char **argv)
 {
        char *name = NULL;
        int ret, old = 0, count = -1; /* print af change forever */
@@ -370,7 +367,7 @@ repeat:
        }
        mmd_unlock();
        if (name) {
-               ret = send_va_buffer(socket_fd, "%s\n", name);
+               ret = send_va_buffer(fd, "%s\n", name);
                free(name);
                name = NULL;
                if (ret < 0)
@@ -383,7 +380,7 @@ repeat:
 }
 
 /* sb */
-int com_sb(int socket_fd, int argc, char **argv)
+int com_sb(int fd, int argc, char **argv)
 {
        char *sb;
        int ret, nr = -1;       /* status bar will be printed that many
@@ -396,7 +393,7 @@ int com_sb(int socket_fd, int argc, char **argv)
                mmd_lock();
                sb = get_sb_string(mmd);
                mmd_unlock();
-               ret = send_va_buffer(socket_fd, "%s\n", sb);
+               ret = send_va_buffer(fd, "%s\n", sb);
                free(sb);
                if (ret < 0)
                        return ret;
@@ -410,7 +407,7 @@ int com_sb(int socket_fd, int argc, char **argv)
 }
 
 /* stat */
-int com_stat(int socket_fd, int argc, char **argv)
+int com_stat(int fd, int argc, char **argv)
 {
        int ret, num = 0;/* status will be printed that many
                          * times. num <= 0 means: print forever
@@ -426,7 +423,7 @@ int com_stat(int socket_fd, int argc, char **argv)
 
                mmd_dup(nmmd);
                s = get_status(nmmd);
-               ret = send_buffer(socket_fd, s);
+               ret = send_buffer(fd, s);
                free(s);
                if (ret < 0)
                        goto out;
@@ -528,7 +525,7 @@ int com_help(int fd, int argc, char **argv)
 }
 
 /* hup */
-int com_hup(__a_unused int socket_fd, int argc, __a_unused char **argv)
+int com_hup(__a_unused int fd, int argc, __a_unused char **argv)
 {
        if (argc != 1)
                return -E_COMMAND_SYNTAX;
@@ -537,7 +534,7 @@ int com_hup(__a_unused int socket_fd, int argc, __a_unused char **argv)
 }
 
 /* term */
-int com_term(__a_unused int socket_fd, int argc, __a_unused char **argv)
+int com_term(__a_unused int fd, int argc, __a_unused char **argv)
 {
        if (argc != 1)
                return -E_COMMAND_SYNTAX;
@@ -545,7 +542,7 @@ int com_term(__a_unused int socket_fd, int argc, __a_unused char **argv)
        return 1;
 }
 
-int com_play(__a_unused int socket_fd, int argc, __a_unused char **argv)
+int com_play(__a_unused int fd, int argc, __a_unused char **argv)
 {
        if (argc != 1)
                return -E_COMMAND_SYNTAX;
@@ -558,7 +555,7 @@ int com_play(__a_unused int socket_fd, int argc, __a_unused char **argv)
 }
 
 /* stop */
-int com_stop(__a_unused int socket_fd, int argc, __a_unused char **argv)
+int com_stop(__a_unused int fd, int argc, __a_unused char **argv)
 {
        if (argc != 1)
                return -E_COMMAND_SYNTAX;
@@ -571,7 +568,7 @@ int com_stop(__a_unused int socket_fd, int argc, __a_unused char **argv)
 }
 
 /* pause */
-int com_pause(__a_unused int socket_fd, int argc, __a_unused char **argv)
+int com_pause(__a_unused int fd, int argc, __a_unused char **argv)
 {
        if (argc != 1)
                return -E_COMMAND_SYNTAX;
@@ -610,7 +607,7 @@ int com_chs(int fd, int argc, char **argv)
 }
 
 /* next */
-int com_next(__a_unused int socket_fd, int argc, __a_unused char **argv)
+int com_next(__a_unused int fd, int argc, __a_unused char **argv)
 {
        if (argc != 1)
                return -E_COMMAND_SYNTAX;
@@ -622,7 +619,7 @@ int com_next(__a_unused int socket_fd, int argc, __a_unused char **argv)
 }
 
 /* nomore */
-int com_nomore(__a_unused int socket_fd, int argc, __a_unused char **argv)
+int com_nomore(__a_unused int fd, int argc, __a_unused char **argv)
 {
        if (argc != 1)
                return -E_COMMAND_SYNTAX;
@@ -634,7 +631,7 @@ int com_nomore(__a_unused int socket_fd, int argc, __a_unused char **argv)
 }
 
 /* ff */
-int com_ff(__a_unused int socket_fd, int argc, char **argv)
+int com_ff(__a_unused int fd, int argc, char **argv)
 {
        long promille;
        int ret, backwards = 0;
@@ -673,7 +670,7 @@ out:
 }
 
 /* jmp */
-int com_jmp(__a_unused int socket_fd, int argc, char **argv)
+int com_jmp(__a_unused int fd, int argc, char **argv)
 {
        long unsigned int i;
        int ret;
@@ -727,7 +724,7 @@ static struct server_command *parse_cmd(const char *cmdstr)
        return get_cmd_ptr(buf, NULL);
 }
 
-long int para_rand(long unsigned max)
+static long int para_rand(long unsigned max)
 {
        return (long int) ((max + 0.0) * (random() / (RAND_MAX + 1.0)));
 }
@@ -757,6 +754,37 @@ static void rc4_send(unsigned long len, const unsigned char *indata,
        RC4(&rc4_send_key, len, indata, outdata);
 }
 
+/**
+ * perform user authentication and execute a command
+ *
+ * \param fd the file descriptor to send output to
+ * \param addr socket address info of peer
+ *
+ * \return EXIT_SUCCESS or EXIT_FAILURE
+ *
+ * Whenever para_server accepts an incoming tcp connection on
+ * the port it listens on, it forks and the resulting child
+ * calls this function.
+ *
+ * An RSA-based challenge/response is used to authenticate
+ * the peer. It that authentication succeeds, a random RC4
+ * session key is generated and sent back to the peer,
+ * encrypted with its RSA public key.  From this point on,
+ * all transfers are crypted with this session key.
+ *
+ * Next it is checked if the peer supplied  a valid server
+ * command or a command for the audio file selector currently
+ * in use.  If yes, and if the user has sufficient
+ * permissions to execute that command, the function calls
+ * the corresponding command handler which does argument
+ * checking and further processing.
+ *
+ * In order to cope with a DOS attacks, a timeout is set up
+ * which terminates the function if the connection was not
+ * authenticated when the timeout expires.
+ *
+ * \sa alarm(2), rc4(3), crypt.c, crypt.h
+ */
 int handle_connect(int fd, struct sockaddr_in *addr)
 {
        int numbytes, ret, argc, use_rc4 = 0;
@@ -774,7 +802,6 @@ int handle_connect(int fd, struct sockaddr_in *addr)
        signal(SIGHUP, SIG_DFL);
        signal(SIGUSR1, SIG_IGN);
 
-       in_addr = addr;
        challenge_nr = random();
        /* send Welcome message */
        ret = send_va_buffer(fd, "This is para_server, version "