1 /*************************************************************************** 2 * nmap_tty.h -- Handles runtime interaction with Nmap, so you can * 3 * increase verbosity/debugging or obtain a status line upon request. * 4 * * 5 ***********************IMPORTANT NMAP LICENSE TERMS************************ 6 * * 7 * The Nmap Security Scanner is (C) 1996-2020 Insecure.Com LLC ("The Nmap * 8 * Project"). Nmap is also a registered trademark of the Nmap Project. * 9 * * 10 * This program is distributed under the terms of the Nmap Public Source * 11 * License (NPSL). The exact license text applying to a particular Nmap * 12 * release or source code control revision is contained in the LICENSE * 13 * file distributed with that version of Nmap or source code control * 14 * revision. More Nmap copyright/legal information is available from * 15 * https://nmap.org/book/man-legal.html, and further information on the * 16 * NPSL license itself can be found at https://nmap.org/npsl. This header * 17 * summarizes some key points from the Nmap license, but is no substitute * 18 * for the actual license text. * 19 * * 20 * Nmap is generally free for end users to download and use themselves, * 21 * including commercial use. It is available from https://nmap.org. * 22 * * 23 * The Nmap license generally prohibits companies from using and * 24 * redistributing Nmap in commercial products, but we sell a special Nmap * 25 * OEM Edition with a more permissive license and special features for * 26 * this purpose. See https://nmap.org/oem * 27 * * 28 * If you have received a written Nmap license agreement or contract * 29 * stating terms other than these (such as an Nmap OEM license), you may * 30 * choose to use and redistribute Nmap under those terms instead. * 31 * * 32 * The official Nmap Windows builds include the Npcap software * 33 * (https://npcap.org) for packet capture and transmission. It is under * 34 * separate license terms which forbid redistribution without special * 35 * permission. So the official Nmap Windows builds may not be * 36 * redistributed without special permission (such as an Nmap OEM * 37 * license). * 38 * * 39 * Source is provided to this software because we believe users have a * 40 * right to know exactly what a program is going to do before they run it. * 41 * This also allows you to audit the software for security holes. * 42 * * 43 * Source code also allows you to port Nmap to new platforms, fix bugs, * 44 * and add new features. You are highly encouraged to submit your * 45 * changes as a Github PR or by email to the dev@nmap.org mailing list * 46 * for possible incorporation into the main distribution. Unless you * 47 * specify otherwise, it is understood that you are offering us very * 48 * broad rights to use your submissions as described in the Nmap Public * 49 * Source License Contributor Agreement. This is important because we * 50 * fund the project by selling licenses with various terms, and also * 51 * because the inability to relicense code has caused devastating * 52 * problems for other Free Software projects (such as KDE and NASM). * 53 * * 54 * The free version of Nmap is distributed in the hope that it will be * 55 * useful, but WITHOUT ANY WARRANTY; without even the implied warranty of * 56 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. Warranties, * 57 * indemnification and commercial support are all available through the * 58 * Npcap OEM program--see https://nmap.org/oem. * 59 * * 60 ***************************************************************************/ 61 62 #ifndef NMAP_TTY_H 63 #define NMAP_TTY_H 64 65 /* 66 * Initializes the terminal for unbuffered non-blocking input. Also 67 * registers tty_done() via atexit(). You need to call this before 68 * you ever call keyWasPressed(). 69 */ 70 void tty_init(); 71 72 /* Catches all of the predefined keypresses and interpret them, and it 73 will also tell you if you should print anything. A value of true 74 being returned means a nonstandard key has been pressed and the 75 calling method should print a status message */ 76 bool keyWasPressed(); 77 78 #endif 79