LCOV - code coverage report
Current view: top level - lib - fko_message.c (source / functions) Hit Total Coverage
Test: lcov_coverage_final.info Lines: 113 113 100.0 %
Date: 2014-11-16 Functions: 10 10 100.0 %
Branches: 110 120 91.7 %

           Branch data     Line data    Source code
       1                 :            : /*
       2                 :            :  *****************************************************************************
       3                 :            :  *
       4                 :            :  * File:    fko_message.c
       5                 :            :  *
       6                 :            :  * Purpose: Set/Get the spa message (access req/command/etc) based
       7                 :            :  *          on the current spa data.
       8                 :            :  *
       9                 :            :  *  Fwknop is developed primarily by the people listed in the file 'AUTHORS'.
      10                 :            :  *  Copyright (C) 2009-2014 fwknop developers and contributors. For a full
      11                 :            :  *  list of contributors, see the file 'CREDITS'.
      12                 :            :  *
      13                 :            :  *  License (GNU General Public License):
      14                 :            :  *
      15                 :            :  *  This program is free software; you can redistribute it and/or
      16                 :            :  *  modify it under the terms of the GNU General Public License
      17                 :            :  *  as published by the Free Software Foundation; either version 2
      18                 :            :  *  of the License, or (at your option) any later version.
      19                 :            :  *
      20                 :            :  *  This program is distributed in the hope that it will be useful,
      21                 :            :  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
      22                 :            :  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
      23                 :            :  *  GNU General Public License for more details.
      24                 :            :  *
      25                 :            :  *  You should have received a copy of the GNU General Public License
      26                 :            :  *  along with this program; if not, write to the Free Software
      27                 :            :  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307
      28                 :            :  *  USA
      29                 :            :  *
      30                 :            :  *****************************************************************************
      31                 :            : */
      32                 :            : #include "fko_common.h"
      33                 :            : #include "fko_message.h"
      34                 :            : #include "fko.h"
      35                 :            : 
      36                 :            : static int
      37                 :    3950069 : have_allow_ip(const char *msg)
      38                 :            : {
      39                 :    3950069 :     const char         *ndx     = msg;
      40                 :            :     char                ip_str[MAX_IPV4_STR_LEN];
      41                 :    3950069 :     int                 dot_ctr = 0, char_ctr = 0;
      42                 :    3950069 :     int                 res     = FKO_SUCCESS;
      43                 :            : 
      44         [ +  + ]:   44326034 :     while(*ndx != ',' && *ndx != '\0')
      45                 :            :     {
      46                 :   40533355 :         ip_str[char_ctr] = *ndx;
      47                 :   40533355 :         char_ctr++;
      48         [ +  + ]:   40533355 :         if(char_ctr >= MAX_IPV4_STR_LEN)
      49                 :            :         {
      50                 :            :             res = FKO_ERROR_INVALID_ALLOW_IP;
      51                 :            :             break;
      52                 :            :         }
      53         [ +  + ]:   40528478 :         if(*ndx == '.')
      54                 :            :             dot_ctr++;
      55         [ +  + ]:   29146374 :         else if(isdigit(*ndx) == 0)
      56                 :            :         {
      57                 :            :             res = FKO_ERROR_INVALID_ALLOW_IP;
      58                 :            :             break;
      59                 :            :         }
      60                 :   40375965 :         ndx++;
      61                 :            :     }
      62                 :            : 
      63         [ +  + ]:    3950069 :     if(char_ctr < MAX_IPV4_STR_LEN)
      64                 :    3945192 :         ip_str[char_ctr] = '\0';
      65                 :            :     else
      66                 :            :         res = FKO_ERROR_INVALID_ALLOW_IP;
      67                 :            : 
      68         [ +  + ]:    3950069 :     if(res == FKO_SUCCESS)
      69         [ +  + ]:    3792679 :         if (! is_valid_ipv4_addr(ip_str))
      70                 :      36783 :             res = FKO_ERROR_INVALID_ALLOW_IP;
      71                 :            : 
      72                 :    3950069 :     return(res);
      73                 :            : }
      74                 :            : 
      75                 :            : static int
      76                 :    6915312 : have_port(const char *msg)
      77                 :            : {
      78                 :    6915312 :     const char  *ndx = msg;
      79                 :    6915312 :     char        port_str[MAX_PORT_STR_LEN+1] = {0};
      80                 :    6915312 :     int         startlen = strnlen(msg, MAX_SPA_MESSAGE_SIZE);
      81                 :    6915312 :     int         port_str_len=0, i=0, is_err;
      82                 :            : 
      83         [ +  - ]:    6915312 :     if(startlen == MAX_SPA_MESSAGE_SIZE)
      84                 :            :         return(FKO_ERROR_INVALID_DATA_MESSAGE_PORT_MISSING);
      85                 :            : 
      86                 :            :     /* Must have at least one digit for the port number
      87                 :            :     */
      88         [ +  + ]:    6915312 :     if(isdigit(*ndx) == 0)
      89                 :            :         return(FKO_ERROR_INVALID_SPA_ACCESS_MSG);
      90                 :            : 
      91         [ +  + ]:   26424664 :     while(*ndx != '\0' && *ndx != ',')
      92                 :            :     {
      93                 :   19618296 :         port_str_len++;
      94 [ +  + ][ +  + ]:   19618296 :         if((isdigit(*ndx) == 0) || (port_str_len > MAX_PORT_STR_LEN))
      95                 :            :             return(FKO_ERROR_INVALID_SPA_ACCESS_MSG);
      96                 :   19524767 :         port_str[i] = *ndx;
      97                 :   19524767 :         ndx++;
      98                 :   19524767 :         i++;
      99                 :            :     }
     100                 :    6806368 :     port_str[i] = '\0';
     101                 :            : 
     102                 :    6806368 :     strtol_wrapper(port_str, 1, MAX_PORT, NO_EXIT_UPON_ERR, &is_err);
     103         [ +  + ]:    6806368 :     if(is_err != FKO_SUCCESS)
     104                 :            :         return(FKO_ERROR_INVALID_SPA_ACCESS_MSG);
     105                 :            : 
     106                 :    6806348 :     return FKO_SUCCESS;
     107                 :            : }
     108                 :            : 
     109                 :            : /* Set the SPA message type.
     110                 :            : */
     111                 :            : int
     112                 :    5088702 : fko_set_spa_message_type(fko_ctx_t ctx, const short msg_type)
     113                 :            : {
     114                 :            : #if HAVE_LIBFIU
     115         [ +  + ]:    5088702 :     fiu_return_on("fko_set_spa_message_type_init",
     116                 :            :             FKO_ERROR_CTX_NOT_INITIALIZED);
     117                 :            : #endif
     118                 :            :     /* Must be initialized
     119                 :            :     */
     120 [ +  + ][ +  - ]:    5088699 :     if(!CTX_INITIALIZED(ctx))
     121                 :            :         return FKO_ERROR_CTX_NOT_INITIALIZED;
     122                 :            : 
     123                 :            : #if HAVE_LIBFIU
     124         [ +  + ]:    5087865 :     fiu_return_on("fko_set_spa_message_type_val",
     125                 :            :             FKO_ERROR_INVALID_DATA_MESSAGE_TYPE_VALIDFAIL);
     126                 :            : #endif
     127         [ +  + ]:    5087862 :     if(msg_type < 0 || msg_type >= FKO_LAST_MSG_TYPE)
     128                 :            :         return(FKO_ERROR_INVALID_DATA_MESSAGE_TYPE_VALIDFAIL);
     129                 :            : 
     130                 :    5083569 :     ctx->message_type = msg_type;
     131                 :            : 
     132                 :    5083569 :     ctx->state |= FKO_SPA_MSG_TYPE_MODIFIED;
     133                 :            : 
     134                 :    5083569 :     return(FKO_SUCCESS);
     135                 :            : }
     136                 :            : 
     137                 :            : /* Return the SPA message type.
     138                 :            : */
     139                 :            : int
     140                 :       6604 : fko_get_spa_message_type(fko_ctx_t ctx, short *msg_type)
     141                 :            : {
     142                 :            : 
     143                 :            : #if HAVE_LIBFIU
     144         [ +  + ]:       6604 :     fiu_return_on("fko_get_spa_message_type_init",
     145                 :            :             FKO_ERROR_CTX_NOT_INITIALIZED);
     146                 :            : #endif
     147                 :            : 
     148                 :            :     /* Must be initialized
     149                 :            :     */
     150 [ +  + ][ +  - ]:       6602 :     if(!CTX_INITIALIZED(ctx))
     151                 :            :         return FKO_ERROR_CTX_NOT_INITIALIZED;
     152                 :            : 
     153         [ +  + ]:       6034 :     if(msg_type == NULL)
     154                 :            :         return(FKO_ERROR_INVALID_DATA);
     155                 :            : 
     156                 :            : #if HAVE_LIBFIU
     157         [ +  + ]:       5966 :     fiu_return_on("fko_get_spa_message_type_val", FKO_ERROR_INVALID_DATA);
     158                 :            : #endif
     159                 :            : 
     160                 :       5964 :     *msg_type = ctx->message_type;
     161                 :            : 
     162                 :       5964 :     return(FKO_SUCCESS);
     163                 :            : }
     164                 :            : 
     165                 :            : /* Set the SPA MESSAGE data
     166                 :            : */
     167                 :            : int
     168                 :    1615552 : fko_set_spa_message(fko_ctx_t ctx, const char * const msg)
     169                 :            : {
     170                 :    1615552 :     int res = FKO_ERROR_UNKNOWN;
     171                 :            : 
     172                 :            :     /* Context must be initialized.
     173                 :            :     */
     174 [ +  + ][ +  - ]:    1615552 :     if(!CTX_INITIALIZED(ctx))
     175                 :            :         return FKO_ERROR_CTX_NOT_INITIALIZED;
     176                 :            : 
     177                 :            :     /* Gotta have a valid string.
     178                 :            :     */
     179 [ +  + ][ +  + ]:    1615538 :     if(msg == NULL || strnlen(msg, MAX_SPA_MESSAGE_SIZE) == 0)
     180                 :            :         return(FKO_ERROR_INVALID_DATA_MESSAGE_EMPTY);
     181                 :            : 
     182                 :            :     /* --DSS XXX: Bail out for now.  But consider just
     183                 :            :      *            truncating in the future...
     184                 :            :     */
     185         [ +  + ]:    1615355 :     if(strnlen(msg, MAX_SPA_MESSAGE_SIZE) == MAX_SPA_MESSAGE_SIZE)
     186                 :            :         return(FKO_ERROR_DATA_TOO_LARGE);
     187                 :            : 
     188                 :            :     /* Basic message type and format checking...
     189                 :            :     */
     190         [ +  + ]:    1614599 :     if(ctx->message_type == FKO_COMMAND_MSG)
     191                 :       1788 :         res = validate_cmd_msg(msg);
     192                 :            :     else
     193                 :    1612811 :         res = validate_access_msg(msg);
     194                 :            : 
     195         [ +  + ]:    1614599 :     if(res != FKO_SUCCESS)
     196                 :            :         return(res);
     197                 :            : 
     198                 :            :     /* Just in case this is a subsquent call to this function.  We
     199                 :            :      * do not want to be leaking memory.
     200                 :            :     */
     201         [ +  + ]:    1607960 :     if(ctx->message != NULL)
     202                 :       1008 :         free(ctx->message);
     203                 :            : 
     204                 :    1607960 :     ctx->message = strdup(msg);
     205                 :            : 
     206                 :    1607960 :     ctx->state |= FKO_DATA_MODIFIED;
     207                 :            : 
     208         [ +  - ]:    1607960 :     if(ctx->message == NULL)
     209                 :            :         return(FKO_ERROR_MEMORY_ALLOCATION);
     210                 :            : 
     211                 :    1607960 :     return(FKO_SUCCESS);
     212                 :            : }
     213                 :            : 
     214                 :            : /* Return the SPA message data.
     215                 :            : */
     216                 :            : int
     217                 :    1591482 : fko_get_spa_message(fko_ctx_t ctx, char **msg)
     218                 :            : {
     219                 :            : 
     220                 :            : #if HAVE_LIBFIU
     221         [ +  + ]:    1591482 :     fiu_return_on("fko_get_spa_message_init", FKO_ERROR_CTX_NOT_INITIALIZED);
     222                 :            : #endif
     223                 :            : 
     224                 :            :     /* Must be initialized
     225                 :            :     */
     226 [ +  + ][ +  - ]:    1591480 :     if(!CTX_INITIALIZED(ctx))
     227                 :            :         return(FKO_ERROR_CTX_NOT_INITIALIZED);
     228                 :            : 
     229         [ +  + ]:    1591328 :     if(msg == NULL)
     230                 :            :         return(FKO_ERROR_INVALID_DATA);
     231                 :            : 
     232                 :            : #if HAVE_LIBFIU
     233         [ +  + ]:    1591260 :     fiu_return_on("fko_get_spa_message_val", FKO_ERROR_INVALID_DATA);
     234                 :            : #endif
     235                 :            : 
     236                 :    1591258 :     *msg = ctx->message;
     237                 :            : 
     238                 :    1591258 :     return(FKO_SUCCESS);
     239                 :            : }
     240                 :            : 
     241                 :            : /* Validate a command message format.
     242                 :            : */
     243                 :            : int
     244                 :      44790 : validate_cmd_msg(const char *msg)
     245                 :            : {
     246                 :            :     const char   *ndx;
     247                 :      44790 :     int     res         = FKO_SUCCESS;
     248                 :      44790 :     int     startlen    = strnlen(msg, MAX_SPA_CMD_LEN);
     249                 :            : 
     250         [ +  - ]:      44790 :     if(startlen == MAX_SPA_CMD_LEN)
     251                 :            :         return(FKO_ERROR_INVALID_DATA_MESSAGE_CMD_MISSING);
     252                 :            : 
     253                 :            :     /* Should always have a valid allow IP regardless of message type
     254                 :            :     */
     255         [ +  + ]:      44790 :     if((res = have_allow_ip(msg)) != FKO_SUCCESS)
     256                 :            :         return(FKO_ERROR_INVALID_SPA_COMMAND_MSG);
     257                 :            : 
     258                 :            :     /* Commands are fairly free-form so all we can really verify is
     259                 :            :      * there is something at all. Get past the IP and comma, and make
     260                 :            :      * sure we have some string leftover...
     261                 :            :     */
     262                 :      30666 :     ndx = strchr(msg, ',');
     263 [ +  + ][ +  + ]:      30666 :     if(ndx == NULL || (1+(ndx - msg)) >= startlen)
     264                 :            :         return(FKO_ERROR_INVALID_SPA_COMMAND_MSG);
     265                 :            : 
     266                 :      29286 :     return(FKO_SUCCESS);
     267                 :            : }
     268                 :            : 
     269                 :            : int
     270                 :    3692384 : validate_access_msg(const char *msg)
     271                 :            : {
     272                 :            :     const char   *ndx;
     273                 :    3692384 :     int     res         = FKO_SUCCESS;
     274                 :    3692384 :     int     startlen    = strnlen(msg, MAX_SPA_MESSAGE_SIZE);
     275                 :            : 
     276         [ +  - ]:    3692384 :     if(startlen == MAX_SPA_MESSAGE_SIZE)
     277                 :            :         return(FKO_ERROR_INVALID_DATA_MESSAGE_ACCESS_MISSING);
     278                 :            : 
     279                 :            :     /* Should always have a valid allow IP regardless of message type
     280                 :            :     */
     281         [ +  + ]:    3692384 :     if((res = have_allow_ip(msg)) != FKO_SUCCESS)
     282                 :            :         return(res);
     283                 :            : 
     284                 :            :     /* Position ourselves beyond the allow IP and make sure we are
     285                 :            :      * still good.
     286                 :            :     */
     287                 :    3574343 :     ndx = strchr(msg, ',');
     288 [ +  + ][ +  + ]:    3574343 :     if(ndx == NULL || (1+(ndx - msg)) >= startlen)
     289                 :            :         return(FKO_ERROR_INVALID_SPA_ACCESS_MSG);
     290                 :            : 
     291                 :            :     /* Look for a comma to see if this is a multi-part access request.
     292                 :            :     */
     293                 :            :     do {
     294                 :    6782850 :         ndx++;
     295                 :    6782850 :         res = validate_proto_port_spec(ndx);
     296         [ +  + ]:    6782850 :         if(res != FKO_SUCCESS)
     297                 :            :             break;
     298         [ +  + ]:    6698034 :     } while((ndx = strchr(ndx, ',')));
     299                 :            : 
     300                 :            :     return(res);
     301                 :            : }
     302                 :            : 
     303                 :            : int
     304                 :     212895 : validate_nat_access_msg(const char *msg)
     305                 :            : {
     306                 :            :     const char   *ndx;
     307                 :     212895 :     int     res         = FKO_SUCCESS;
     308                 :     212895 :     int     startlen    = strnlen(msg, MAX_SPA_MESSAGE_SIZE);
     309                 :            : 
     310         [ +  - ]:     212895 :     if(startlen == MAX_SPA_MESSAGE_SIZE)
     311                 :            :         return(FKO_ERROR_INVALID_DATA_MESSAGE_NAT_MISSING);
     312                 :            : 
     313                 :            :     /* Should always have a valid allow IP regardless of message type
     314                 :            :     */
     315         [ +  + ]:     212895 :     if((res = have_allow_ip(msg)) != FKO_SUCCESS)
     316                 :            :         return(FKO_ERROR_INVALID_SPA_NAT_ACCESS_MSG);
     317                 :            : 
     318                 :            :     /* Position ourselves beyond the allow IP and make sure we have
     319                 :            :      * a single port value
     320                 :            :     */
     321                 :     150887 :     ndx = strchr(msg, ',');
     322 [ +  + ][ +  + ]:     150887 :     if(ndx == NULL || (1+(ndx - msg)) >= startlen)
     323                 :            :         return(FKO_ERROR_INVALID_SPA_NAT_ACCESS_MSG);
     324                 :            : 
     325                 :     147135 :     ndx++;
     326                 :            : 
     327         [ +  + ]:     147135 :     if((res = have_port(ndx)) != FKO_SUCCESS)
     328                 :            :         return(FKO_ERROR_INVALID_SPA_NAT_ACCESS_MSG);
     329                 :            : 
     330         [ +  + ]:     108314 :     if(msg[startlen-1] == ',')
     331                 :            :         return(FKO_ERROR_INVALID_SPA_NAT_ACCESS_MSG);
     332                 :            : 
     333                 :     107934 :     return(res);
     334                 :            : }
     335                 :            : 
     336                 :            : int
     337                 :    6782850 : validate_proto_port_spec(const char *msg)
     338                 :            : {
     339                 :    6782850 :     int     startlen    = strnlen(msg, MAX_SPA_MESSAGE_SIZE);
     340                 :    6782850 :     const char   *ndx   = msg;
     341                 :            : 
     342         [ +  - ]:    6782850 :     if(startlen == MAX_SPA_MESSAGE_SIZE)
     343                 :            :         return(FKO_ERROR_INVALID_DATA_MESSAGE_PORTPROTO_MISSING);
     344                 :            : 
     345                 :            :     /* Now check for proto/port string.
     346                 :            :     */
     347         [ +  + ]:    6782850 :     if(strncmp(ndx, "tcp", 3)
     348         [ +  + ]:    2690112 :       && strncmp(ndx, "udp", 3)
     349         [ +  + ]:      12337 :       && strncmp(ndx, "icmp", 4)
     350         [ +  + ]:      11497 :       && strncmp(ndx, "none", 4))
     351                 :            :         return(FKO_ERROR_INVALID_SPA_ACCESS_MSG);
     352                 :            : 
     353                 :    6771354 :     ndx = strchr(ndx, '/');
     354 [ +  + ][ +  + ]:    6771354 :     if(ndx == NULL || ((1+(ndx - msg)) > MAX_PROTO_STR_LEN))
     355                 :            :         return(FKO_ERROR_INVALID_SPA_ACCESS_MSG);
     356                 :            : 
     357                 :            :     /* Skip over the '/' and make sure we only have digits.
     358                 :            :     */
     359                 :    6768177 :     ndx++;
     360                 :            : 
     361                 :    6768177 :     return have_port(ndx);
     362                 :            : }
     363                 :            : 
     364                 :            : /***EOF***/

Generated by: LCOV version 1.10