├── .gitignore ├── Makefile ├── README ├── src ├── nfgen.h ├── binaryoutput.c ├── binaryoutput.h ├── udp.c ├── errors.h ├── udp.h ├── hosts.h ├── netflow.h ├── netflow.c ├── nfgen.c └── hosts.c └── COPYING /.gitignore: -------------------------------------------------------------------------------- 1 | *~ 2 | *.o 3 | nfgen 4 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | CC=gcc 2 | CFLAGS=-c -g -Wall -pedantic -std=c99 3 | LDFLAGS= 4 | EXECUTABLE=nfgen 5 | 6 | SOURCES_DIR=src/ 7 | SOURCES=$(addprefix $(SOURCES_DIR), nfgen.c hosts.c netflow.c udp.c binaryoutput.c) 8 | 9 | OBJECTS=$(SOURCES:.c=.o) 10 | 11 | 12 | .PHONY: build debug clean install 13 | 14 | all: $(EXECUTABLE) 15 | 16 | $(EXECUTABLE): $(OBJECTS) 17 | $(CC) $(LDFLAGS) $(OBJECTS) -o $@ 18 | 19 | .c.o: 20 | $(CC) $(CFLAGS) $< -o $@ 21 | 22 | clean: 23 | rm -f $(OBJECTS) $(EXECUTABLE) 24 | 25 | #install: $(EXECUTABLE) 26 | # cp $(EXECUTABLE) $(INSTALL_PATH) 27 | 28 | -------------------------------------------------------------------------------- /README: -------------------------------------------------------------------------------- 1 | DESCRIPTION 2 | A simple utility suitable for testing NetFlow applications. It generates 3 | pseudo-random NetFlow packets and sends them to specified collector. 4 | 5 | BUILD 6 | make 7 | 8 | USAGE 9 | ./nfgen [-a address] [-p port] [-s seed] [-o file] 10 | -a collector address (default 127.0.0.1) 11 | -p destination port (default 2055) 12 | -s generator seed (default 1) 13 | -o output file 14 | 15 | EXAMPLES 16 | ./nfgen -a 147.229.176.14 -p2055 -s5 17 | 18 | TESTING 19 | Testing of this utility can be done using netcat. Make nc listen on the 20 | specified UDP port 21 | 22 | nc -ul 2055 > recieved 23 | 24 | and run nfgen with -o option. 25 | 26 | ./nfgen -a 127.0.0.1 -p 2055 -o sent 27 | 28 | nfgen will dump everything it sends to a file. Then diff the files and see. 29 | 30 | diff sent recieved 31 | 32 | -------------------------------------------------------------------------------- /src/nfgen.h: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2010 by Radek Pazdera 3 | * 4 | * This file is part of nfgen. 5 | * 6 | * nfgen is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * nfgen is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with nfgen. If not, see . 18 | */ 19 | 20 | #ifndef _NFGEN__H_ 21 | #define _NFGEN__H_ 22 | 23 | struct cliArguments 24 | { 25 | in_addr_t address; 26 | in_port_t port; 27 | char* outputFile; 28 | int seed; 29 | int help; 30 | }; 31 | 32 | #endif 33 | -------------------------------------------------------------------------------- /src/binaryoutput.c: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2010 by Radek Pazdera 3 | * 4 | * This file is part of nfgen. 5 | * 6 | * nfgen is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * nfgen is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with nfgen. If not, see . 18 | */ 19 | 20 | #include "binaryoutput.h" 21 | 22 | #include 23 | #include 24 | 25 | FILE* openOutputFile(char* path) 26 | { 27 | FILE* file = fopen(path, "w+b"); 28 | 29 | if (file == NULL) 30 | { 31 | perror("Unable to write to output file."); 32 | exit(EXIT_FAILURE); 33 | } 34 | 35 | return file; 36 | } 37 | 38 | void writeToOutputFile(FILE* file, void* datagram, size_t datagramSize) 39 | { 40 | fwrite(datagram, sizeof(char), datagramSize, file); 41 | fflush(file); 42 | 43 | if (ferror(file)) 44 | { 45 | perror("Cannot write into output file."); 46 | exit(EXIT_FAILURE); 47 | } 48 | } 49 | 50 | void closeOutputFile(FILE* file) 51 | { 52 | fclose(file); 53 | } 54 | 55 | -------------------------------------------------------------------------------- /src/binaryoutput.h: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2010 by Radek Pazdera 3 | * 4 | * This file is part of nfgen. 5 | * 6 | * nfgen is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * nfgen is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with nfgen. If not, see . 18 | */ 19 | 20 | #ifndef _BINARYOUTPUT__H_ 21 | #define _BINARYOUTPUT__H_ 22 | 23 | #include 24 | 25 | /** 26 | * Open output file and return the handle 27 | * 28 | * The file is open in binary mode "w+b". It calls 29 | * exit() on error. 30 | * 31 | * TODO 32 | * Calling exit is a bad thing. Only main module should 33 | * be able to control the application runtime. 34 | * 35 | * @param[in] path Absolute/relative file path 36 | * @return Open file handle 37 | */ 38 | FILE* openOutputFile(char* path); 39 | 40 | /** 41 | * Write datagram into file 42 | * 43 | * Writes \c datagramSize bytes from \c datagram buffer 44 | * into \c file and flushes the stream. 45 | * 46 | * It calls exit() upon error. 47 | * TODO Fix that. 48 | * 49 | * @param[in] file Open file (@see openOutputFile()) 50 | * @param[in] datagram Data to be stored into the file 51 | * @param[in] datagramSize Number of bytes to write 52 | * 53 | * @return void 54 | */ 55 | void writeToOutputFile(FILE* file, void* datagram, size_t datagramSize); 56 | 57 | /** 58 | * Close open file handle 59 | * @param[in] file Open file 60 | * 61 | * @return void 62 | */ 63 | void closeOutputFile(FILE* file); 64 | 65 | #endif 66 | 67 | 68 | -------------------------------------------------------------------------------- /src/udp.c: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2010 by Radek Pazdera 3 | * 4 | * This file is part of nfgen. 5 | * 6 | * nfgen is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * nfgen is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with nfgen. If not, see . 18 | */ 19 | 20 | #include 21 | #include 22 | #include 23 | #include 24 | 25 | #include 26 | #include 27 | #include 28 | #include 29 | 30 | #include 31 | 32 | #include "udp.h" 33 | 34 | int udpInitialize() 35 | { 36 | int udpSocket = socket(AF_INET, SOCK_DGRAM, 0); 37 | 38 | if (udpSocket <= 0) 39 | { 40 | perror("Unable to create socket."); 41 | exit(EXIT_FAILURE); 42 | } 43 | 44 | return udpSocket; 45 | } 46 | 47 | size_t udpSend(int udpSocket, in_addr_t address, in_port_t port, void *message, size_t messageSize) 48 | { 49 | struct stat info; 50 | if (fstat(udpSocket, &info) != 0) 51 | { 52 | perror("Descriptor is invalid."); 53 | exit(EXIT_FAILURE); 54 | } 55 | 56 | struct sockaddr_in remoteAddress; 57 | memset(&remoteAddress, 0, sizeof(remoteAddress)); 58 | 59 | remoteAddress.sin_family = AF_INET; 60 | remoteAddress.sin_addr.s_addr = address; 61 | remoteAddress.sin_port = htons(port); 62 | 63 | ssize_t numberOfBytesSend = sendto(udpSocket, message, messageSize, 0, 64 | (const struct sockaddr *) &remoteAddress, sizeof(remoteAddress)); 65 | 66 | return numberOfBytesSend; 67 | } 68 | 69 | void udpClose(int udpSocket) 70 | { 71 | close(udpSocket); 72 | } 73 | 74 | -------------------------------------------------------------------------------- /src/errors.h: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2010 by Radek Pazdera 3 | * 4 | * This file is part of nfgen. 5 | * 6 | * nfgen is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * nfgen is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with nfgen. If not, see . 18 | */ 19 | 20 | #ifndef _ERRORS__H_ 21 | #define _ERRORS__H_ 22 | 23 | #include 24 | #include 25 | 26 | /** Error codes. 27 | * 28 | * Errors are represented by error codes. This program 29 | * uses standard C posix defined error codes that are 30 | * available from errno.h. On top of that, EOK constant 31 | * was defined to signal no error was encountered. 32 | * 33 | * Frequently used standard errors: 34 | * EOK 35 | * EIO i/o error 36 | * EINVAL invalid argument 37 | * ENOENT file doesn't exist 38 | * ENOMEM not enough memory 39 | * EACCES permission denied 40 | */ 41 | typedef int error_t; 42 | 43 | #define EOK 0 44 | 45 | /** Error reporting function. 46 | * 47 | * Function prints error specified error message. 48 | * The format is 49 | * 50 | * : : 51 | * 52 | * This implementation writes to stderr. Change this if 53 | * you want to handle errors differently (for example 54 | * log with syslog or suppress reporting entirely). 55 | * 56 | * If the supplied \c errorCode is invalid, the reason 57 | * printed will be "Unknown error" 58 | * 59 | * @param[in] errorCode Posix error code 60 | * @param[in] message String to print as message 61 | * 62 | * @return 0 63 | */ 64 | static inline void printError(error_t errorCode, char* message) 65 | { 66 | error(0, errorCode, "%s", message); 67 | } 68 | 69 | #endif 70 | 71 | -------------------------------------------------------------------------------- /src/udp.h: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2010 by Radek Pazdera 3 | * 4 | * This file is part of nfgen. 5 | * 6 | * nfgen is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * nfgen is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with nfgen. If not, see . 18 | */ 19 | 20 | #ifndef _UDP__H_ 21 | #define _UDP__H_ 22 | 23 | #include 24 | #include 25 | #include 26 | #include 27 | 28 | /** 29 | * Initialize socket for UDP communication 30 | * 31 | * Basic initialization of a socket for further 32 | * use. Pass the result to udpSend(). 33 | * 34 | * @return SOCK_DGRAM socket file descriptor. 35 | */ 36 | int udpInitialize(void); 37 | 38 | /** 39 | * Send a datagram using UDP 40 | * 41 | * Sends first \c messageSize bytes from \c message buffer 42 | * to a remote host specified by the \c address and \c port. 43 | * Unreilable User Datagram Protocol is used. 44 | * 45 | * @param[in] udpSocket Initialized socket file descriptor (@see udpInitialize()) 46 | * @param[in] address Remote host IP address 47 | * @param[in] port Remote host port number 48 | * @param[in] message Message content buffer (must be >= messageSize) 49 | * @param[in] messageSize Size of the message in buffer 50 | * 51 | * @return Number of successfully transfered bytes 52 | */ 53 | size_t udpSend(int udpSocket, in_addr_t address, in_port_t port, void *message, size_t messageSize); 54 | 55 | /** 56 | * Close UDP socket 57 | * 58 | * Close UDP socket and free any resources 59 | * allocated by udpInitialize(). 60 | * 61 | * @param[in] udpSocket Socket file descriptor 62 | */ 63 | void udpClose(int udpSocket); 64 | 65 | #endif 66 | 67 | -------------------------------------------------------------------------------- /src/hosts.h: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2010 by Radek Pazdera 3 | * 4 | * This file is part of nfgen. 5 | * 6 | * nfgen is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * nfgen is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with nfgen. If not, see . 18 | */ 19 | 20 | #ifndef _HOSTS__H_ 21 | #define _HOSTS__H_ 22 | 23 | #include "errors.h" 24 | 25 | #include 26 | 27 | /** 28 | * Convert ip address from string to in_addr_t 29 | * 30 | * @param[in] addressInDotNotation IP to convert in string form 31 | * @param[out] address Resulting address. 32 | * 33 | * @return Status code EOK on success, EAFNOSUPPORT on failure 34 | */ 35 | error_t convertAddress(const char *addressInDotNotation, in_addr_t* address); 36 | 37 | /** 38 | * Load hosts from file 39 | * 40 | * Reads hosts file and returns an array of ip addresses. 41 | * The file must be in the following format 42 | * 43 | * # Comment 44 | * 127.0.0.1 45 | * 192.168.0.1 # Also a comment 46 | * 47 | * 10.0.0.1 48 | * 49 | * That means one address per line, blank lines, spaces and 50 | * everything after '#' up to the end of the line is ignored. 51 | * 52 | * TODO Test with Windows CR-LF line endings. 53 | * 54 | * Badly formed addresses are ignored with a warning on stderr. 55 | * 56 | * Returned array is allocated within the function and is not 57 | * free'd. Your responsibility is to correctly release the 58 | * memory. 59 | * 60 | * @param[in] filePath Location of the file 61 | * @param[out] hosts Pointer to an array of in_addr_t 62 | * 63 | * @return Number of addresses read or -1 on error 64 | */ 65 | error_t readHostsFromFile(char* filePath, in_addr_t** hosts); 66 | #endif 67 | -------------------------------------------------------------------------------- /src/netflow.h: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2010 by Radek Pazdera 3 | * 4 | * This file is part of nfgen. 5 | * 6 | * nfgen is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * nfgen is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with nfgen. If not, see . 18 | */ 19 | 20 | #ifndef _NETFLOW__H_ 21 | #define _NETFLOW__H_ 22 | 23 | #include 24 | #include 25 | 26 | #define MAX_NETFLOW_PDU_SIZE 1464 27 | #define MAX_NETFLOW_RECORDS 30 28 | 29 | /** NetFlow version 5 PDU header */ 30 | struct netflowHeader 31 | { 32 | uint16_t version; /* 5 */ 33 | uint16_t count; /* The number of records in the PDU */ 34 | uint32_t sysUpTime; /* Current time in millisecs since router booted */ 35 | uint32_t unixSecs; /* Current seconds since 0000 UTC 1970 */ 36 | uint32_t unixNsecs; /* Residual nanoseconds since 0000 UTC 1970 */ 37 | uint32_t flowSequence; /* Seq counter of total flows seen */ 38 | uint8_t engineType; /* Type of flow switching engine (RP,VIP,etc.) */ 39 | uint8_t engineId; /* Slot number of the flow switching engine */ 40 | uint16_t reserved; 41 | }; 42 | 43 | /** NetFlow version 5 record */ 44 | struct netflowRecord 45 | { 46 | uint32_t srcAddr; /* Source IP Address */ 47 | uint32_t dstAddr; /* Destination IP Address */ 48 | uint32_t nextHop; /* Next hop router's IP Address */ 49 | uint16_t input; /* Input interface index */ 50 | uint16_t output; /* Output interface index */ 51 | uint32_t dPkts; /* Packets sent in Duration */ 52 | uint32_t dOctets; /* Octets sent in Duration. */ 53 | uint32_t first; /* SysUptime at start of flow */ 54 | uint32_t last; /* and of last packet of flow */ 55 | uint16_t srcPort; /* TCP/UDP source port number or equivalent */ 56 | uint16_t dstPort; /* TCP/UDP destination port number or equiv */ 57 | uint8_t pad; 58 | uint8_t tcpFlags; /* Cumulative OR of tcp flags */ 59 | uint8_t prot; /* IP protocol, e.g., 6=TCP, 17=UDP, ... */ 60 | uint8_t tos; /* IP Type-of-Service */ 61 | uint16_t srcAs; /* originating AS of source address */ 62 | uint16_t dstAs; /* originating AS of destination address */ 63 | uint8_t srcMask; /* source address prefix mask bits */ 64 | uint8_t dstMask; /* destination address prefix mask bits */ 65 | uint16_t drops; 66 | }; 67 | 68 | /** 69 | * Make pseudo-random NetFlow PDU 70 | * 71 | * Creates semi-random NetFlow v5 into \c buffer. 72 | * Some attributes are random and some are computed and 73 | * set so they make sense in the stream comming from this 74 | * exporter. 75 | * 76 | * Size of the resulting PDU can reach up to 1464 bytes 77 | * (24B for header + up to 30 records, each of 48B = 1464). 78 | * The buffer size must be greater or equal, otherwise 79 | * expect some segfaults. 80 | * 81 | * @param[out] buffer Buffer for NetFlow PDU 82 | * @param[in] systemStartTime Start of NetFlow exporter (this program) \ 83 | * This value is later used to determine flow durations. 84 | * @param[in] numberOfFLows How many records should be generated into the PDU 85 | * @param[in] totalFlowsSent Total number of flows sent from \c systemStartTime \ 86 | * by this exporter including \c current numberOfFlows 87 | * 88 | * @return Final PDU size stored in \c buffer 89 | */ 90 | size_t makeRandomNetflowPacket(char *buffer, time_t systemStartTime, unsigned int numberOfFlows, unsigned int totalFlowsSent); 91 | 92 | 93 | #endif 94 | -------------------------------------------------------------------------------- /src/netflow.c: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2010 by Radek Pazdera 3 | * 4 | * This file is part of nfgen. 5 | * 6 | * nfgen is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * nfgen is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with nfgen. If not, see . 18 | */ 19 | 20 | #include 21 | #include 22 | #include 23 | #include 24 | 25 | #include "netflow.h" 26 | #include "hosts.h" 27 | 28 | #define MIN_FLOW_DURATION 1 29 | #define MAX_FLOW_DURATION 60 30 | 31 | /* Here goes some addresses that will be used as source and destination in netflow records. */ 32 | /* TODO Maybe load them from a file? */ 33 | #define NUMBER_OF_ADDRESSES 4 34 | const char *addresses[NUMBER_OF_ADDRESSES] = 35 | { 36 | "127.0.0.1", 37 | "192.168.1.100", 38 | "192.168.1.101", 39 | "192.168.1.102" 40 | }; 41 | 42 | /* TODO This could be more sophisticated */ 43 | /* Is 'generate' really the right name? */ 44 | in_addr_t generateRandomAddress() 45 | { 46 | in_addr_t address; 47 | 48 | convertAddress(addresses[(1 + rand()) % NUMBER_OF_ADDRESSES], &address); 49 | return address; 50 | } 51 | 52 | in_port_t generateRandomPortNumber() 53 | { 54 | return rand() % 65536; 55 | } 56 | 57 | char generateRandomTCPFlags() 58 | { 59 | return rand() % 255; 60 | } 61 | 62 | /* Returns size of the packet in buffer. 63 | Size of buffer must be greater then 24 + 30*48 = 1464, 64 | otherwise expect some segfaults. */ 65 | size_t makeRandomNetflowPacket(char *buffer, time_t systemStartTime, unsigned int numberOfFlows, unsigned int totalFlowsSent) 66 | { 67 | time_t currentTime = time(0); 68 | time_t systemUptime = currentTime - systemStartTime; 69 | 70 | struct netflowRecord record; 71 | struct netflowHeader header; 72 | 73 | for (int flow = 0;flow < numberOfFlows; flow++) 74 | { 75 | // Addresses are already in network byte order 76 | record.srcAddr = generateRandomAddress(); 77 | record.dstAddr = generateRandomAddress(); 78 | 79 | // NIY 80 | record.nextHop = 0; 81 | record.input = 0; 82 | record.output = 0; 83 | 84 | // Some random flow lengths 85 | record.dPkts = rand() % 100000; 86 | record.dOctets = record.dPkts * (rand() % 300); 87 | record.dPkts = htonl(record.dPkts); 88 | record.dOctets = htonl(record.dOctets); 89 | 90 | // Flow duration 91 | if (systemUptime < MAX_FLOW_DURATION) 92 | { 93 | record.first = 0; 94 | } 95 | else 96 | { 97 | record.first = (systemUptime - (MIN_FLOW_DURATION + rand()) % MAX_FLOW_DURATION)*1000; 98 | } 99 | record.last = record.first + (rand() % MAX_FLOW_DURATION)*1000; 100 | record.first = htonl(record.first); 101 | record.last = htonl(record.last); 102 | 103 | record.srcPort = htons(generateRandomPortNumber()); 104 | record.dstPort = htons(generateRandomPortNumber()); 105 | 106 | record.pad = 0; 107 | 108 | // Transport protocol (TCP|UDP) 109 | record.prot = rand() % 2 ? IPPROTO_TCP : IPPROTO_UDP; 110 | record.tcpFlags = record.prot == IPPROTO_TCP ? generateRandomTCPFlags() : 0; 111 | 112 | // NIY 113 | record.tos = 0; 114 | record.srcAs = 0; 115 | record.dstAs = 0; 116 | record.srcMask = 0; 117 | record.dstMask = 0; 118 | 119 | record.drops = 0; 120 | 121 | memcpy(buffer + sizeof(struct netflowHeader) + flow*sizeof(struct netflowRecord), &record, sizeof(struct netflowRecord)); 122 | } 123 | 124 | /* Setup header */ 125 | header.version = htons(5); 126 | header.count = htons(numberOfFlows); 127 | 128 | header.sysUpTime = htonl((currentTime - systemStartTime) * 1000); // Time since the program was run is used 129 | header.unixSecs = htonl(currentTime); 130 | 131 | // Random amount of residual nanoseconds is generated for testing purposes 132 | header.unixNsecs = htonl(rand() % (1000000000 - 1)); 133 | 134 | header.flowSequence = htonl(totalFlowsSent); 135 | 136 | memcpy(buffer, &header, sizeof(struct netflowHeader)); 137 | 138 | // returns size of generated pdu 139 | return sizeof(struct netflowHeader) + numberOfFlows*sizeof(struct netflowRecord); 140 | } 141 | 142 | 143 | -------------------------------------------------------------------------------- /src/nfgen.c: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2010 by Radek Pazdera 3 | * 4 | * This file is part of nfgen. 5 | * 6 | * nfgen is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * nfgen is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with nfgen. If not, see . 18 | */ 19 | 20 | #include 21 | #include 22 | #include 23 | #include 24 | 25 | #include 26 | #include 27 | 28 | #include 29 | #include 30 | #include 31 | #include 32 | 33 | #include "errors.h" 34 | #include "netflow.h" 35 | #include "nfgen.h" 36 | #include "udp.h" 37 | #include "hosts.h" 38 | #include "binaryoutput.h" 39 | 40 | /* Local port number */ 41 | #define SRC_PORT 10000 42 | 43 | /* Default CLI arguments */ 44 | #define DEFAULT_ADDRESS "127.0.0.1" 45 | #define DEFAULT_PORT 2055 46 | #define DEFAULT_SEED time(NULL) 47 | 48 | /* TODO A helpful help could be more useful. */ 49 | void usage(int exitCode) 50 | { 51 | fprintf(stderr, "Usage: nfgen [-a address] [-p port] [-s seed] [-o path]\n"); 52 | fprintf(stderr, " -a collector addres (default %s)\n", DEFAULT_ADDRESS); 53 | fprintf(stderr, " -p dest port (default %i)\n", DEFAULT_PORT); 54 | fprintf(stderr, " -s generator seed (default randomized)\n"); 55 | fprintf(stderr, " -o output file\n"); 56 | 57 | exit(exitCode); 58 | } 59 | 60 | struct cliArguments parseCliArguments(int argc, char **argv) 61 | { 62 | error_t status = EOK; 63 | 64 | struct cliArguments arguments; 65 | convertAddress(DEFAULT_ADDRESS, &arguments.address); 66 | arguments.port = DEFAULT_PORT; 67 | arguments.seed = DEFAULT_SEED; 68 | arguments.outputFile = NULL; 69 | arguments.help = 0; 70 | 71 | int option; 72 | /* TODO Some validation would be nice ... */ 73 | while ((option = getopt(argc, argv, "a:p:s:o:h")) != -1) 74 | { 75 | switch (option) 76 | { 77 | case 'a': 78 | status = convertAddress(optarg, &arguments.address); 79 | if (status != EOK) 80 | { 81 | printError(status, "Invalid 'a' option argument"); 82 | usage(EXIT_FAILURE); 83 | } 84 | break; 85 | case 'p': 86 | arguments.port = atoi(optarg); 87 | break; 88 | case 's': 89 | arguments.seed = atoi(optarg); 90 | break; 91 | case 'o': 92 | arguments.outputFile = (char*) malloc((strlen(optarg) + 1)*sizeof(char)); 93 | strcpy(arguments.outputFile, optarg); 94 | break; 95 | case 'h': 96 | usage(EXIT_SUCCESS); 97 | break; 98 | default: 99 | printError(0, "Unknown option"); 100 | usage(EXIT_FAILURE); 101 | } 102 | } 103 | 104 | return arguments; 105 | } 106 | 107 | void freeCliArguments(struct cliArguments arguments) 108 | { 109 | if (arguments.outputFile != NULL) 110 | { 111 | free(arguments.outputFile); 112 | } 113 | } 114 | 115 | int main(int argc, char **argv) 116 | { 117 | error_t status; 118 | 119 | struct cliArguments arguments = parseCliArguments(argc, argv); 120 | 121 | time_t systemStartTime = time(0); 122 | unsigned int numberOfFlows = 0; 123 | unsigned int totalFlowsSent = 0; 124 | 125 | /* Initialize generator */ 126 | srand(arguments.seed); 127 | 128 | char buffer[MAX_NETFLOW_PDU_SIZE]; 129 | memset(buffer, 0, MAX_NETFLOW_PDU_SIZE); 130 | size_t pduSize; 131 | 132 | int udpSocket = udpInitialize(); 133 | FILE* outputFile = (arguments.outputFile != NULL) ? openOutputFile(arguments.outputFile) : NULL; 134 | 135 | while(1) 136 | { 137 | numberOfFlows = (1 + rand()) % MAX_NETFLOW_RECORDS; 138 | totalFlowsSent += numberOfFlows; 139 | pduSize = makeRandomNetflowPacket(buffer, systemStartTime, numberOfFlows, totalFlowsSent); 140 | 141 | /* FIXME Some more information would be nice */ 142 | if (udpSend(udpSocket, arguments.address, arguments.port, buffer, pduSize) == pduSize) 143 | { 144 | if (arguments.outputFile != NULL) 145 | { 146 | writeToOutputFile(outputFile, buffer, pduSize); 147 | } 148 | 149 | fprintf(stderr, "Packet of size %i with %i flows sent.\n", pduSize, numberOfFlows); 150 | } 151 | else 152 | { 153 | fprintf(stderr, "Sending failed.\n"); 154 | } 155 | 156 | /* TODO Interval ought to be more versatile */ 157 | sleep(rand() % 3); 158 | } 159 | 160 | if (outputFile != NULL) 161 | { 162 | closeOutputFile(outputFile); 163 | } 164 | 165 | udpClose(udpSocket); 166 | freeCliArguments(arguments); 167 | 168 | return EXIT_SUCCESS; 169 | } 170 | 171 | -------------------------------------------------------------------------------- /src/hosts.c: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2010 by Radek Pazdera 3 | * 4 | * This file is part of nfgen. 5 | * 6 | * nfgen is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * nfgen is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with nfgen. If not, see . 18 | */ 19 | 20 | #include 21 | #include 22 | #include 23 | #include 24 | #include 25 | #include "errors.h" 26 | 27 | /* Public interface. */ 28 | #include "hosts.h" 29 | 30 | enum fsmStates 31 | { 32 | WHITESPACE, 33 | ADDRESS, 34 | COMMENT, 35 | CARRIAGE_RETURN 36 | }; 37 | 38 | #define BUFFER_ALLOCATION_UNIT 16 39 | typedef struct 40 | { 41 | char* string; 42 | size_t size; 43 | int free; 44 | } buffer_t; 45 | 46 | 47 | /** Initialize buffer_t structure. 48 | * 49 | * During the initiailzation stage the buffer is 50 | * allocated to a size specified by BUFFER_ALLOCATION_UNIT 51 | * constant. Size and empty is set appropriatelly. 52 | * 53 | * @param[out] buffer Buffer structure address 54 | * 55 | * @return EOK on success, EMEMORY on malloc failure. 56 | */ 57 | static error_t initializeBuffer(buffer_t* buffer); 58 | 59 | /** Apend \c character to \c buffer. 60 | * 61 | * Buffer is dynamically allocated. If it runs out 62 | * of space it allocates additional memory to store 63 | * the characters. 64 | * 65 | * The array is expanded in chunks of size specified 66 | * by BUFFER_ALLOCATION_UNIT. 67 | * 68 | * @param[in] character Character to add to the buffer. 69 | * @param[in, out] buffer Target buffer_t structure. It must 70 | * be initialized by initializeBuffer() 71 | * before adding new characters. 72 | * 73 | * @return EOK on succes, EMEMORY on realloc failure. 74 | */ 75 | static error_t addToBuffer(char character, buffer_t* buffer); 76 | 77 | /** Empty buffer. 78 | * 79 | * The buffer must be initialized (@see initializeBuffer()). 80 | * This function doesn't resize or free the memory. 81 | * Instead it wipes the content and makes the buffer 82 | * empty. 83 | * 84 | * @param[in,out] buffer Initialized buffer. 85 | */ 86 | static void emptyBuffer(buffer_t* buffer); 87 | 88 | /** Free allocated memory for buffer. 89 | * 90 | * Release memory and reset the structure 91 | * to it's default state (i.e. reset size and 92 | * free). 93 | * 94 | * @param[in, out] buffer Buffer to be free'd. 95 | */ 96 | static void freeBuffer(buffer_t* buffer); 97 | 98 | /** Check if character is a whitespace. 99 | */ 100 | static bool isWhiteSpace(char character); 101 | 102 | /** Check if character starts a comment. 103 | */ 104 | static bool startsComment(char character); 105 | 106 | 107 | error_t convertAddress(const char *addressInDotNotation, in_addr_t* address) 108 | { 109 | error_t status; 110 | 111 | status = inet_pton(AF_INET, addressInDotNotation, (void *) address); 112 | if (status <= 1) 113 | { 114 | if (status == 0) 115 | { 116 | return EINVAL; 117 | } 118 | return EAFNOSUPPORT; 119 | } 120 | 121 | return EOK; 122 | } 123 | 124 | error_t readHostsFromFile(char* filePath, in_addr_t** hosts) 125 | { 126 | error_t status; 127 | char character; 128 | enum fsmStates state = WHITESPACE; 129 | 130 | FILE* hostsFile = fopen(filePath, "r"); 131 | if (hostsFile == NULL) 132 | { 133 | return errno; /* set by fopen() */ 134 | } 135 | 136 | buffer_t buffer; 137 | status = initializeBuffer(&buffer); 138 | if (status != EOK) 139 | { 140 | return status; 141 | } 142 | 143 | while (!feof(hostsFile)) 144 | { 145 | character = fgetc(hostsFile); 146 | 147 | switch (state) 148 | { 149 | case WHITESPACE: 150 | if (isWhiteSpace(character)) 151 | { 152 | continue; 153 | } 154 | else if (startsComment(character)) 155 | { 156 | state = COMMENT; 157 | } 158 | else 159 | { 160 | state = ADDRESS; 161 | addToBuffer(character, &buffer); 162 | } 163 | break; 164 | 165 | case ADDRESS: 166 | if (isWhiteSpace(character)) 167 | { 168 | /* TODO Convert address and flush the buffer. */ 169 | state = WHITESPACE; 170 | } 171 | else if (startsComment(character)) 172 | { 173 | /* the same */ 174 | state = COMMENT; 175 | } 176 | else 177 | { 178 | addToBuffer(character, &buffer); 179 | } 180 | break; 181 | 182 | case COMMENT: 183 | if (character == '\r') 184 | { 185 | state = CARRIAGE_RETURN; 186 | } 187 | else if (character == '\n') 188 | { 189 | state = WHITESPACE; 190 | } 191 | else 192 | { 193 | /* Do nothing. */ 194 | } 195 | break; 196 | 197 | case CARRIAGE_RETURN: 198 | if (character == '\n') 199 | { 200 | state = WHITESPACE; 201 | } 202 | else 203 | { 204 | return EILSEQ; 205 | } 206 | break; 207 | } 208 | } 209 | 210 | freeBuffer(&buffer); 211 | fclose(hostsFile); 212 | 213 | return 0; 214 | } 215 | 216 | error_t initializeBuffer(buffer_t* buffer) 217 | { 218 | buffer->string = (char*) malloc(BUFFER_ALLOCATION_UNIT); 219 | if (buffer->string == NULL) 220 | { 221 | return ENOMEM; 222 | } 223 | 224 | buffer->string[0] = '\0'; 225 | buffer->size = BUFFER_ALLOCATION_UNIT; 226 | buffer->free = buffer->size - 1; 227 | 228 | return EOK; 229 | } 230 | 231 | error_t addToBuffer(char character, buffer_t* buffer) 232 | { 233 | if (!buffer->free) 234 | { 235 | /* Buffer is full. Allocate more space. */ 236 | char* newString = realloc(buffer->string, buffer->size + BUFFER_ALLOCATION_UNIT); 237 | if (newString == NULL) 238 | { 239 | return ENOMEM; 240 | } 241 | 242 | buffer->string = newString; 243 | buffer->size += BUFFER_ALLOCATION_UNIT; 244 | buffer->free += BUFFER_ALLOCATION_UNIT; 245 | } 246 | 247 | int firstFree = buffer->size - buffer->free - 1; 248 | 249 | buffer->string[firstFree] = character; 250 | buffer->string[firstFree+1] = '\0'; 251 | buffer->free--; 252 | 253 | return EOK; 254 | } 255 | 256 | void emptyBuffer(buffer_t* buffer) 257 | { 258 | buffer->string[0] = '\0'; 259 | buffer->free = buffer->size - 1; 260 | } 261 | 262 | void freeBuffer(buffer_t* buffer) 263 | { 264 | free(buffer->string); 265 | 266 | buffer->string = NULL; 267 | buffer->size = 0; 268 | buffer->free = 0; 269 | } 270 | 271 | bool isWhiteSpace(char character) 272 | { 273 | return character == ' ' || character == '\t' || 274 | character == '\r' || character == '\n'; 275 | } 276 | 277 | bool startsComment(char character) 278 | { 279 | return character == '#'; 280 | } 281 | 282 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------