1 <?xml version="1.0" encoding="UTF-8"?>
2 <!DOCTYPE doc SYSTEM "/usr/local/xslt/doc.dtd">
3 <doc style="main.css" xmlns:xlink="http://www.w3.org/1999/xlink">
8 <subtitle>GNU COMPUTER MONITORING</subtitle>
9 <subtitle>A system for interactive system monitoring.</subtitle>
10 <subtitle>Development manifest</subtitle>
12 <author>Brenno J.S.A.A.F. de Winter, De Winter Information Solutions</author>
13 <author>Arjen Baart, Andromeda Technology & Automation</author>
14 <date>October 05, 2002.</date>
16 <infoitem label="Version">0.20</infoitem>
24 <heading>About this document.</heading>
27 This document describes the technical specifications for the Gnucomo project.
28 It will describe the functionality achieved, design specifications and choices made.
29 The document will be the manifest for the developers to work in the same direction
30 and not run into unneeded disappointments.
34 <heading>History of the document.</heading>
36 <table cpos='lp{3cm}lp{5cm}'>
38 <col>Version</col><col>Author</col><col>Date</col><col>Remarks</col>
41 <col>0.l</col><col>Brenno de Winter</col><col>Jul 11, 2002</col>
47 <col>0.11</col><col>Arjen Baart</col><col>Jul 12, 2002</col>
49 Additional guidelines and dataflow diagram.
53 <col>0.12</col><col>Brenno de Winter</col><col>Jul 15, 2002</col>
59 <col>0.13</col><col>Arjen Baart</col><col>Jul 16, 2002</col>
61 Entity-relationship model added.
65 <col>0.14</col><col>Brenno de Winter</col><col>Jul 17, 2002</col>
67 Based on feedback. Small changes to the datamodel and finishing touches
68 in lay-out of the tables. Added some examples.
72 <col>0.15</col><col>Brenno de Winter, Arjen Baart</col><col>Jul 21, 2002</col>
74 Additional feedback processed, indexes added, ERD added and SQL-script created.
78 <col>0.16</col><col>Brenno de Winter</col><col>Aug 7, 2002</col>
80 Communication handling added.
84 <col>0.17</col><col>Brenno de Winter</col><col>Aug 11, 2002</col>
86 <para>* Description of the client-side for communications.</para>
87 <para>* Several updates to the database descriptions, drawings added.</para>
88 <para>* More work on the installation chapter.</para>
89 <para>* Created an extra field to the unprocessed_log table and added
90 a between the table service and unprocessed_log.</para>
94 <col>0.18</col><col>Brenno de Winter, Peter Roozemaal</col><col>Aug 15, 2002</col>
96 <para>* Review done by Peter Roozemaal: adjusted intro and several clarifications made</para>
97 <para>* Arjen Baart: Adjustments to database drawings</para>
98 <para>* New installation recommendations</para>
102 <col>0.19</col><col>Arjen Baart</col><col>Aug 27, 2002</col>
108 <col>0.20</col><col>Arjen Baart</col><col>Oct 20, 2002</col>
110 Minor layout improvements
119 <heading>Aim of the project.</heading>
122 The number of log-files in a system and the tools in general do not make
123 monitoring a system simple. Quite often there is so much information that
124 attention for logfiles seems to fade away. For that reason monitoring routers
125 and clients is often not an option. Instead of timely detection of problems,
126 logs more often are used to find out what went wrong. When a system is
127 under attack early signals can often easily be detected<footnote>Just as in
128 real life there a signals that things are not going in the right direction.
129 For the attacks on September 11th 2001 there were many signals available
130 that could to have led to early detection: warnings of several intelligence
131 agencies, warnings within the FBI, flight schools that report strange
132 customers that want to steer a plane and don't seem to care about take
133 off and landing, people opening accounts under fake names.</footnote>
134 and preventive measures could have been taken if the time was only available.
138 The Gnucomo project is meant to make pro-active monitoring of computers
139 and devices easier. It will contain a set of applications that will
140 retrieve all types of monitoring information from devices and place
141 it into a database. Devices can be server computers, desktop computers,
142 PBX'es or other systems. By running checks the manual process of
143 watching log files can be reduced. Also an intelligent script can
144 see things that a human being will easy overlook. Gnucomo won't
145 relieve an administrator of all manual work on log-files, but will
146 increase the changes on actual monitoring.
149 With all this data being available at one central location the gnucomo-server
150 acts as some kind of black box for computer systems. If something does
151 happen the evidence will be available at a remote location available
152 for exploration<footnote>This analogy is based on a remarkable anecdote:
153 One a trip to US I spoke to a 747-captain of Air France. While talking
154 over several subjects we touched security. When we went some deeper I
155 touched the subject gnucomo and he told me that Air France was doing
156 the very same with real black boxes. By sending all the data to Paris
157 errors can be detected earlier and be resolved. In any less fortunate
158 case the cause of the crash might be detected sooner (or fuller).
159 For me this was a signal there is a point in working gnucomo because
160 the analogy is valid.</footnote>. Forensics will be made easier.
161 Also the collected data is available from multiple locations make
162 it easier to found more about an attack. The change that you overlook
163 things will be reduced.
166 Based on the entered data all sorts of analysis will be performed to discover
167 abnormalities a normal maintenance tool or IDS wouldn't be looking at.
168 An example could be a website in Dutch that suddenly obtains a lot of
169 attention from Greek visitors (based on the location of their
170 IP<footnote>That IP could also warn for other things like: excessive
171 data traffic from wireless connections at times that you wouldn't be
172 expecting traffic at all, absence of traffic when you would be expecting
173 some traffic at least or even what article is liked in which part of the world,
174 what regions poses the highest threat to the security of the system (based
175 on the location of the IP address).</footnote>). These abnormalities will
176 be presented as user-friendly as possible to increase awareness of the
177 state of the system. By doing that the system can also be used for more
178 complex analysis. One than can look at long-term trends like hacking
179 attempts that take place, new exploits that are tried all of a sudden
180 or signs of distributed attacks or a certain pattern of attempts<footnote>A portscan
181 that last three days is hard to detect with a real-time IDS,
182 while gnucomo would discover this anyhow. With correct intelligence
183 one portscan from multiple IP-addresses can be related.</footnote>.
186 Also extra data will be gathered where ever possible to save time to
187 the administrator. If IP address attract attention of gnucomo the next
188 logical step would be to use tools like dig, whois and visiting arin-related
189 websites. This data will automatically be collected in an early stage and
190 stored in the database.
193 The results will be gathered in a warning system.
194 Those warnings will be presented to the administrative person
195 who is responsible for that particular machine or network.
196 Having multiple systems in the system can add to the intelligence that
197 can be gathered. The interface will be web-based and aimed at user-friendliness.
200 Since multiple systems can enter data into the Gnucomo database more
201 intelligent hardware and security detection can be done.
202 When things do go wrong Gnucomo contains as much information as
203 possible to figure out what happened and assist in the forensics.
204 Since research on the signals afterwards is broader more attention
205 will be given as much data as possible and do less filtering.
208 With the data in the database also policies can be checked automatically
209 retro-actively so that the security leaves some room to stretch some rules.
210 This may sound not logic, because one of the main functions of security is
211 to enforce rules. But some rules are made with the different meanings.
212 For instance: a rule may be that private browsing isn't allowed.
213 The background of such a rule might be to try and reduce the amount
214 of data traffic (too many people downloading mp3's, or people not
215 getting to work anymore). By monitoring that specific fact
216 (bandwidth spent on non-business related Internet use)
217 it's possible to be relaxed on that rule and enable many good-willing
218 users reading his/hers daily newspaper.
221 The scope of the project is clearly limited to monitoring and not to
222 offer automated maintenance or web-based maintenance.
223 There are other projects currently being able to provide that
224 functionality. We will focus on intelligence and user-friendliness
225 of representation of facts presented. A warning should trigger
226 an administrator to get up and do something using the tools he or she values the most.
229 Also we are not aiming to replace great tools like SNORT as a real-time IDS.
230 These tools can do thing, that in the beginning won't be a part of gnucomo
231 out of performance reasons. Also there is no need to duplicate what they
232 already did. If that energy is placed in intelligent we're very complimentary.
233 Gnucomo can however be a reality check on an existing NIDS (Network Intrusion
234 Detection System). For instance if warnings keep coming it may be time to
235 rethink the rules that have been set.
239 This evolves to the following list of functions gnucomo can provide:
242 <item> Intrusion detection </item>
243 <item> Detecting hacker attempts </item>
244 <item> Early detection of system failures </item>
245 <item> Exhaustion of system resources </item>
246 <item> Capacity planning for future expansion </item>
247 <item> Spotting bottlenecks in a system. </item>
248 <item> Verifying system integrity </item>
249 <item> Assistance with troubleshooting </item>
250 <item> Perform post-mortem forensics </item>
251 <item> Incident response system. </item>
256 <heading>Decisions for the overall system.</heading>
259 In order to get the project running we have to make some decisions before
260 we can start. Of course are the decisions always open for review,
261 but initially our main aim is to get a system running. This doesn't
262 mean that we allow a lesser architecture, but more that we create an
263 environment that will lead to results.
266 The following decisions apply to the system in general:
270 The major part of the system will be used for security features.
271 The solution itself has to be secure.
274 In general we strive to be as platform and application independent as possible.
275 However to achieve software to get ready and to assure progress some selections
276 will have to be made excluding options for applications<footnote>An example is
277 in the database. By using stored procedures and triggers MySQL cannot be used.
278 However the data integrity at that point is more important than the ability to
279 use MySQL.</footnote>. Where possible we will enable ports to other applications
283 The computers collecting the data will only be Linux machines,
284 with future support for other Unices. However it is not aim our
285 to port this part of the project to other platforms just now.
288 The database system will make heavy use of stored procedures and
289 triggers and thus lock out some less feature-full database.
292 Although we're not married to a database system initially this will be
293 PostgreSQL only so that we can build for results. The code however
294 shouldn't be build to deliberately lock outer systems.
295 Other database that might be interesting to add: DB2, Oracle
296 (if the rainfall of security advisories seems to be over) and Informix.
299 The interface for the user will be a web-interface written in PHP
300 with PostgreSQL-database access. Despite the fact that initially
301 this will be the preferred way to communicate with our system,
302 other interfaces are welcome and should be supported.
305 The technologies used for the daemons on the central site and remote
306 site are open for discussion. A decision is made when it is clear what
307 exactly will be needed to code.
310 The original logfiles on systems will not be harmed in any way,
311 but will be saved the way they presented to gnucomo.
314 In the database processed data as well as raw data will be stored.
317 Our main aim is to ease the life of the administrator when dealing with
318 the symptoms of a machine so that he doesn't miss important notifications.
319 The project will be made around detection. We won't focus on making a
320 maintenance applications but solely on monitoring, because other applications
321 like webmin or linuxconf do already deliver such functionality.
322 We are complementary to those applications. This doesn't mean that
323 the system cannot send SMS'es, e-mails or make alarms sound.
326 Any output of the logbook will be stored and sent within a certain
327 interval which can be set. By doing that the mechanism will not flood
328 the total mechanism and overload machines.
331 When applications for gnucomo we will try and do the non-server part
332 as platform independent as possible. This in order to prevent writing
333 a same application multiple times. For instance one for Unices, one
334 for Macintosh and one for Microsoft.
337 To ensure the quality of software and to prevent any unwanted functionality
338 rolling into the project all code will be reviewed by one of the lead members
339 before it is accepted. Since this project is aimed at throughput speed no
340 formal procedures will be enforced, but we promise not to let software in
341 that hasn't been checked.
348 <heading>Overall system.</heading>
351 The overall systems aims to make maintenance data better accessible and by
352 doing that lowering the barrier to be on alert for intrusions,
353 system failure and other misery that can happen to computer systems.
354 Also more systems can be monitored and even focus can be placed on desktop computers,
355 something that nowadays rarely happens. Since the solution is only aimed at
356 monitoring (with some responses possible) other people can watch their system(s)
357 without being Administrator<footnote>This can be interesting for people using
358 this service and not doing their own maintenance (smaller companies).
359 If technical action needs to be taken a warning can be send to an administrator.
360 This saves costs and time.</footnote>.
363 The main system will know to sides:
367 <item> Central Application - server </item>
368 <item> Monitored System - client </item>
372 The project has been setup as a two sided system in order to be able to
373 guard many computers at the same time.
374 However it may be obvious that both sides of the application can very
375 well be installed on a single system.
378 When events<footnote>A signal can be the outcome of process that finished,
379 logbook entries, warnings from intrusion detection systems,
380 etc. </footnote> happen they will be stored in a file.
381 When this file is delivered to a certain directory a daemon will detect
382 this and start the transfer of the file. The file will be transferred
383 to the central application or the client. This transfer will be triggered
384 immediately after a process has finished or with a certain time-interval
385 when it concerns a logbook. All output will be placed in a directory where
386 the daemon detects it and ensures the transport. For transport currently
387 only two mechanisms will be supported:
391 Encrypted file copy relying on the SSH protocol.
392 On Unix-based systems this will scp (secure copy).
395 E-Mail. The e-mail is encrypted and signed using gpg and then sent to the server.
396 Since the file format will identify the type-of-output the Subject-field of
397 the e-mail is not really needed.
402 <heading>Priority mechanism.</heading>
404 Each notification has a certain priority that requires a different handling
405 of the issue. How each priority will be dealt with is something that can
406 be set per server. The priority mechanism is a simple system of five
407 categories (can be more or less).
413 <heading>The dataflow diagram.</heading>
414 <para>The main dataflow will be as follows.</para>
416 <picture src="dataflow.png" eps="dataflow" scale="0.7"/>
423 <heading>Central Application: signal handler.</heading>
428 <picture src="architecture.png" eps="architecture"/>
429 Illustration 1 Basic overview of the processes on the server.
432 On one machine signals from the network will come in.
433 These signals can be logfiles, result files from applications,
434 remarks entered by the administrator or whatever.
435 Data delivery takes place into a certain directory.
436 A daemon detects that data has come in and will enter it into the database.
437 Once in the database stored procedures and triggers will recognize certain
438 behavior and generate alerts. The user responsible for the server will be
439 confronted with the alerts and can mark them, add comments to it or ignore them.
440 Also it will be possible to do intelligent analysis on not so logical relations
441 per computer or across computers<footnote>A good example could be a portscan
442 on a system that takes place during a week. Normal a simple portscan takes
443 place in a couple of minutes and will thus be easy to detect.
444 By taking a longer period such a scan is harder to detect. </footnote>. Such
445 scripts make detection possible, that is too time consuming to do during
446 processing of the data.
450 <heading>Data processing.</heading>
452 <para>The data processing has four tasks:</para>
455 Extracting data from e-mail and store it in the input-buffer.
456 This can be done by a daemon that checks the e-mail<footnote>It would be logical
457 to place an e-mail server like sendmail or postfix on the server.
458 In many cases the monitored computer will be featuring a SMTP daemon.
459 If a system is comprimised no evidence that comes through will be really
460 trustworthy. By sending it to another machine all evidence that is
461 available will have left the system the moment a hack takes place.</footnote>
462 with a certain interval extracts the e-mails and leave the content
463 in a file in the input buffer. This daemon has only rights to write
464 to the directory it has to write to. <emph>We may as well have the
465 email captured directly by a program with a
466 "gnucomo: |/usr/local/bin/gnucomo-input" - like alias.</emph>
469 Detect files in the input buffer decrypt the content and verify the signature.
470 Another daemon will see the log-files and starts checking if the origin is
471 correct (by verifying the signature) and decrypting the content.
472 The legible files will be processed by entering the data into the database.
475 The database will accept the data and perform a certain number of
476 checks as the data comes in. During the processing of the data
477 abnormalities will be detected and entered into a notification table.
478 The database system will also carry out more complex tasks on given
479 moments in time and enter them as well in the notification table.
482 The database system must be able to undertake action when high
483 alerts are being entered into the database.
484 This can be a couple of things to begin with:
485 send an e-mail or SMS. In a later stage other technologies may be added as well.
486 In this scheme we also make a possibility to escalate problems when no
487 action is taken in a certain amount of time.
493 <heading>Web interface.</heading>
496 The web interface will used to interact with the user.
497 The interface should be intuitive and easy to understand.
498 More important warnings should directly draw attention.
499 The user must be able to perform settings so that warnings
500 can be rated differently than the original settings.
503 The interface will do the following things:
507 Show a list of warnings that are currently open.
510 It must be possible to sort the list on all the fields shown.
513 Deliver detailed information (logbook entries) upon request that have led to the warning.
516 Undertake certain actions like sending
517 <reference href="mailto:abuse@internet-provider.net">abuse@internet-provider.net</reference>
518 e-mails with information.
521 Monitor actions on outstanding issues.
529 <heading>Sending messages to the central gnucomo system.</heading>
532 One of the main tasks is getting all the messages to the database.
533 Ultimately gnucomo will support multiple ways of receiving the data.
534 Basically anything goes, but two mechanisms will be supported in the project
539 E-mail. Messages and elements from logfiles will be sent through e-mail.
542 File copy. Using technologies like scp or ftp (not preferred due to
543 the insecure nature) can place files directly in the receiving directory.
548 <heading>Ensuring data integrity.</heading>
549 <para><TO BE DESCRIBED></para>
553 <heading>Directories and filenames on the server.</heading>
556 Files will be dealt with as if gnucomo were a user (actually there will
557 be a user gnucomo). The files will be placed in the <code>/home/gnucomo/</code> directory.
558 Only <code>/home/gnucomo/incoming/dropbox/</code> can be used to save data in
559 from external systems. All other directories are only available for the user gnucomo.
560 The filename will represent the data that is received. The details are seperated with
561 underscores. When data is sent by e-mail the filename will be written in the first
562 line of the e-mail. A typical filename looks like this:
566 <strong>3_messages_20020807235208_1.asc</strong>
570 the logic behind this is following:
574 <emph>urgency_typeofmessage_timestamp_objectid.typeoffile.</emph>
577 <table cpos='lp{10cm}'>
580 <para>Part of filename</para>
583 <para>Explanation</para>
591 <para>This indicates the urgency of the file. The lower the number the higher
592 it will rank when an overview is given. Standard files are ranked value 3.
593 The ranking works as follows:</para>
594 <para>* 1 <strong>Urgent flash message.</strong> Something urgent needs to
595 be reported. This is only used for emergencies like serious alarms.</para>
596 <para>* 2 <strong>Rapid delivery.</strong> An important message has to get
597 through that is more important than normal delivery, but is not top
598 priority like an emergency.</para>
599 <para>* 3 <strong>Normal.</strong> This is used in most
600 case for normal messages.</para>
601 <para>* 4 <strong>Low priority.</strong> This is data would be useful
602 to place into the system as nice to have.</para>
607 <para>TypeOfMessage</para>
610 <para>This is an indicator what type of data is delivered to gnucomo.
611 There are several categories:</para>
612 <para>* <strong>cron.</strong> This data comes from the /var/log/cron-log (unix).</para>
613 <para>* <strong>httpaccess.</strong> This data comes from the normal http-log (Apache).</para>
614 <para>* <strong>httperror.</strong> This data comes from the http_error-log (Apache).</para>
615 <para>* <strong>maillog.</strong> This data comes from the /var/log/maillog (unix).</para>
616 <para>* <strong>messages.</strong> The data delivered here comes from
617 the /var/log/messages file (unix)</para>
618 <para>* <strong>text.</strong> This file contains a message in plaintext
619 generated by a gnucomo-client and can be anything.
620 It will be dealt with as plaintext.</para>
625 <para>Timestamp</para>
628 <para>The timestamp is made in war-log (YYYYMMDDHHMMSS) format.
629 The timestamp is generated on the client in GMT (to discover
630 discrepancies in timing).</para>
635 <para>Objectid</para>
638 <para>The objectid is the id that is used within the central
639 gnucomo system to recognize the client.
640 Based on this entry the database can link the data to the correct object.
641 Also gpg can obtain the correct e-mail address (by running a query
642 in the database) for verification of the signature of the crypted message.</para>
647 <para>TypeOfFile</para>
650 <para>Indicates the file type:</para>
651 <para>* <strong>asc.</strong> Plaintext ASCII</para>
652 <para>* <strong>gpg.</strong> gpg-crypted data.</para>
653 <para>* <strong>und.</strong> Undertermined data. When files
654 come in by e-mail it is not 100% sure if they are crypted
655 or not. These data has first to be analyzed before it is
656 moved to the correct queue. </para>
662 <heading>Directory for incoming data.</heading>
665 For incoming messages there will be separate directories
666 (<code>/home/gnucomo/incoming/</code>)for:
670 Dropbox. This directory is ready to receive data from all sorts of systems.
671 This directory is world writeable (<strong><emph>but not deleteable!</emph></strong>):
672 <code>/home/gnucomo/incoming/dropbox/</code>
675 Encrypted messages. In this directory messages will be placed that are still
676 gpg-crypted. In this directory the files await decryption and verification of
677 the signature. This directory is: <code>/home/gnucomo/incoming/crypted/</code>
680 Decrypted with errors. During the decryption exercise anything can go wrong.
681 Decrypting can fail or the signature may show errors. If this happens the
682 original message is moved to a different directory:
683 <code>/home/gnucomo/incoming/cryptfail/</code>
686 Inbox. After successful decryption the decrypted message is moved to the inbox.
687 Data that is not encrypted can be moved here from the dropbox after certain
688 verifications. The directory is: <code>/home/gnucomo/incoming/inbox/</code>
691 Processed. After processing the data the file is stored in the directory
692 processed for further reference for a certain amount of time.
693 The directory is: <code>/home/gnucomo/incoming/processed/</code>
696 Archive. After a certain period the files will be archived.
697 Since not every system will archive everything this directory may
698 also be a symbolic link to <code>/dev/null</code>.
699 The used directory is: <code>/home/gnucomo/archive/</code>
705 <heading>Directory for outgoing data.</heading>
708 For outgoing messages the directory <code>/home/gnucomo/outgoing</code> will
709 be used. This directory knows a couple of sub directories:
714 Dropbox. This directory is used by the central gnucomo system to
715 place outgoing messages in.
716 The used directory is: <code>/home/gnucomo/outgoing/dropbox/</code>
719 Outbox. After processing the message (including signing and encrypting
720 when applicable) the messages are placed in the outbox:
721 <code>/home/gnucomo/outgoing/outbox/</code>
724 Processed. After processing the data the file is stored in the
725 directory processed for further reference for a certain amount
726 of time. After sending a message a confirmation will be made that
727 is saved as an incoming message.
728 The directory is: <code>/home/gnucomo/outgoing/processed/</code>
731 Archive. After a certain period the files will be archived.
732 Since not every system will archive everything this directory
733 may also be a symbolic link to <code>/dev/null</code>.
734 The used directory is: <code>/home/gnucomo/archive/</code>
741 <heading>Overview. </heading>
743 <para>The total directory-structure looks like this:</para>
747 /home/gnucomo/archive
748 /home/gnucomo/incoming
749 /home/gnucomo/incoming/crypted
750 /home/gnucomo/incoming/cryptfail
751 /home/gnucomo/incoming/dropbox
752 /home/gnucomo/incoming/inbox
753 /home/gnucomo/incoming/processed
754 /home/gnucomo/outgoing
755 /home/gnucomo/outgoing/dropbox
756 /home/gnucomo/outgoing/outbox
757 /home/gnucomo/outgoing/processed
764 <heading>Directories on the client-side.</heading>
767 On the client-side the files that need to be transmitted will be placed in a
768 directory system as well. In the future this system may not be in use at all
769 devices (routers, certain MS Windows-machine, IP Telephones, etc.). For those
770 systems a different mechanism will become be described here.
771 Initially we focus on Linux systems that will enter data into the database.
774 The filename convention will be totally identical to the filename
775 convention on the server, since this the same mechanism.
778 To facilitate gnucomo client and server on one and the same machine
779 the gnucomo-client should have a different default user.
780 For this purpose the user <strong>gcm_client</strong> will be created.
784 <heading>Directory for incoming data.</heading>
786 For incoming messages there will be separate directories
787 (<code>/home/gnucomo/incoming/</code>)for:
791 Dropbox. This directory is ready to receive data from all sorts of systems.
792 This directory is world writeable (<emph><strong>but not deleteable!</strong></emph>):
793 <code>/home/gcm_client/incoming/dropbox/</code>
796 Encrypted messages. In this directory messages will be placed that
797 are still gpg-crypted. In this directory the files await decryption
798 and verification of the signature.
799 This directory is: <code>/home/gcm_client/incoming/crypted/</code>
802 Decrypted with errors. During the decryption exercise anything can go wrong.
803 Decrypting can fail or the signature may show errors.
804 If this happens the original message is moved to a different directory:
805 <code>/home/gcm_client/incoming/cryptfail/</code>
808 Inbox. After successful decryption the decrypted message is moved
809 to the inbox. Data that is not encrypted can be moved here from
810 the dropbox after certain verifications. The directory is:
811 <code>/home/gcm_client/incoming/inbox/</code>
814 Processed. After processing the data the file is stored
815 in the directory processed for further reference for a
816 certain amount of time. The directory is:
817 <code>/home/gcm_client/incoming/processed/</code>
824 <heading>Directory for outgoing data.</heading>
827 For outgoing messages the directory <code>/home/gcm_client/outgoing</code> will be used.
828 This directory knows a couple of sub directories:
832 Dropbox. This directory is used by the central gnucomo system to place
833 outgoing messages in.
834 The used directory is: <code>/home/gcm_client/outgoing/dropbox/</code>
837 Outbox. After processing the message (including signing and
838 encrypting when applicable) the messages are placed in the outbox:
839 <code>/home/gcm_client/outgoing/outbox/</code>
842 Processed. After processing the data the file is stored in the
843 directory processed for further reference for a certain amount
844 of time. After sending a message a confirmation will be made
845 that is saved as an incoming message.
846 The directory is: <code>/home/gcm_client/outgoing/processed/</code>
852 <heading>Overview. </heading>
853 <para>The total directory-structure looks like this:</para>
857 /home/gcm_client/archive
858 /home/gcm_client /incoming
859 /home/gcm_client/incoming/crypted
860 /home/gcm_client/incoming/cryptfail
861 /home/gcm_client/incoming/dropbox
862 /home/gcm_client/incoming/inbox
863 /home/gcm_client/incoming/processed
864 /home/gcm_client/outgoing
865 /home/gcm_client/outgoing/dropbox
866 /home/gcm_client/outgoing/outbox
867 /home/gcm_client/outgoing/processed
874 <heading>Getting data into the database.</heading>
877 The files in the /home/gnucomo/incoming/inbox/ should be stored in the database.
878 For this purpose there is a table <emph>unprocessed_log</emph>.
879 The data of the filename as well as the content of the file need
880 to be placed in one record.
883 There are some fields that have to be addressed immediately:
887 Servicecode: The servicecode will be obtained out of the filename the
888 is the type_of_message-field in the filename.
891 Objectid: This data is given in the filename it can be found
892 in the <emph>objectid</emph>-part of the filename.
895 Logdata: The data is saved as follows: filename (unaltered)
896 <CR>textual data of the file.
900 The daemon application that delivers the data is called <strong>gcm-input</strong>.
901 It performs the following steps with no extra functionality:
906 <para>Detect if a file is available.</para>
909 <para>Write the data in the database.</para>
914 To write the data in the database a database user gcm_input exists.
915 This user has only the right to enter data into the database.
916 There are no deletion, update or select-permissions.
922 <heading><label name='database'/>The database.</heading>
925 The database is the heart of the system.
926 It will contain all event-data of multiple computers.
927 The intelligence that can be performed on the database will be placed there.
928 To do this as integrated as possible stored procedures and triggers will be used.
929 To begin with we have selected checks to be performed that will be
930 expanded throughout time.
933 Since the gnucomo database and files contain sensitive data
934 security measures have to be in place. Several database users
935 will be exist that have limited rights to perform a certain task
936 ensuring some protection against unauthorized access.
937 However these mechanisms on it's own will work fine, bad maintenance may still
938 screw-up good security. Good database maintenance is needed.
939 For the gnucomo the protection of the valid authentic nature of
940 the data in the database has our highest priority.
943 A <emph>table-name</emph> in this chapter is written in cursive writing.
947 <heading>Database conventions.</heading>
950 The database will be built according the following conventions:
954 All names for tables, indexes and fields will be written in lower
955 case and will be singular. Spaces in names are not allowed.
958 If a table contains field referring to other tables the mother-tables are
959 mentioned in alphabetical order with an underscore between the table-names.
960 So <emph>object</emph> and <emph>user</emph>
961 will make a third table <emph>object_user</emph>
964 A data access user (being the interface) is not allowed to write to
965 the log-entries and the warnings. To change the state of a warning
966 a stored procedure will do so by having a different entry in a table.
967 This should make it possible to discover who did what at which moment in time.
970 The name of two related fields that make the relationship between two
971 tables will be the same to avoid confusion.
977 <heading>Database design.</heading>
980 In the design we anticipate to deliver an as best as possible database performance.
981 That means that data that needs to be entered occasionally can be heavily indexed
982 to increase performance. However data that is mainly stored will only be indexed
983 marginally to have the best possible performance on data entry. If during one of
984 the checks on data-entry a notification is made, the information related to that
985 notification will be indexed very well to increase retrieval performance.
986 What we will try to avoid is that the user interface will cause full table
987 scan and affect the performance of the overall system dramatically.
988 One of the techniques to increase performance on display is to work with views.
989 So where it is feasible we will use them.
992 In general the database must also be maintained well.
993 So daily maintenance scripts should keep the performance good<footnote>PostgreSQL seems
994 to have very good features to do proper maintenance and they have to be exploited to
995 the full extend.</footnote>.
1000 <heading>Actual design.</heading>
1003 In this part of the chapter the tables will be explained and then described
1004 with all important elements. Per table a sub-chapter will be created.
1005 Each table will have a table design, indexes, relationships and the required data
1006 (for those tables where the data itself is relevant in the design or sample data
1007 (for those cases where no set data is needed). For the relationships beside a
1008 description the subset of the total schema has been incorporated in
1009 the document so that it is more clear what exactly is meant.
1010 Due to the complex nature of the design those drawings sometimes will seem funny.
1013 For the fieldtypes the types of PostgreSQL will be used.
1014 These values can be found in Chapter 3 of the PostgreSQL User Manual
1015 (<reference href="http://www.postgresql.org/">http://www.postgresql.org</reference>).
1018 For indexes primary keys are always <emph>unique</emph> and called
1019 primary key in the name. Since unique indexes within PostgreSQL only
1020 work on B-Tree indexes (which is default) we will use B-Tree for all indexes.
1021 In cases where an exception is made the used type of index will be indicated
1022 in the characteristics. A footnote will explain why a different type of
1023 index has been selected.
1027 <heading>action</heading>
1030 In the table action all recognized actions that can be taken are stored.
1031 Several actions will lead to change in <emph>statuscode</emph>.
1032 However this doesn't apply to all actions<footnote>A status NEW
1033 of a notification that cannot be dealt with automatically will
1034 <strong>not</strong> change before a user looked at it.</footnote>.
1035 Actions take place through background processes and the interface.
1036 This table mainly is used for retrieval so indexing will be done as much as possible.
1040 <heading>The fields.</heading>
1043 The table below describes the fields:
1047 <table cpos='lllp{6cm}'>
1049 <col> Fieldname </col> <col> Fieldtype </col> <col> Size </col>
1055 <col> actionid </col> <col> Bigserial </col> <col> 8 </col>
1057 Autonumber bigint (eight bit)
1061 <col> actionname </col> <col> Text </col> <col> <para/> </col>
1063 Short descriptive name for the type of action
1067 <col> statuscode </col> <col> Varchar </col> <col> 3 </col>
1069 New status that will be given to a notification when this action takes place.
1073 <col> description </col> <col> Text </col> <col> <para/> </col>
1075 A longer description (without limit) on the action.
1084 <heading>The indexes.</heading>
1087 Indices for this table are:
1091 <col> Indexname </col> <col> Field </col> <col> Characteristics </col>
1094 <col> act_pk </col> <col> actionID </col> <col> Primary key </col>
1097 <col> act_actionname </col> <col> actionname </col> <col> Unique </col>
1100 <col> act_statuscode </col> <col> statuscode </col> <col> <para/> </col>
1107 <heading>The relationships.</heading>
1110 Relationships with other tables:
1112 <table cpos='llp{7cm}'>
1114 <col> Fieldname </col> <col> Remote Table </col> <col> Remarks </col>
1117 <col> actionid </col> <col> action_notification_user </col>
1119 Each action that takes place will be log. The Actionid will bring
1120 classification to the individual records. This relationship has to be enforced.
1124 <para>In the model this looks like this:</para>
1126 <picture src="erd-action.png" eps="erd-action"/>
1131 <heading>Default data in table.</heading>
1134 The data in this table is standard for the system and part of the design.
1135 The user cannot change this or add value to it.
1138 <table cpos='p{1cm}p{2cm}p{1.5cm}p{6cm}'>
1140 <col> Actionid </col> <col> Actionname </col> <col> Statuscode </col>
1146 <col> 1 </col> <col> Entry in the system </col> <col> NEW </col>
1148 This indicates that a notification is entered into the system. The status is a <strong>NEW</strong>.
1152 <col> 2 </col> <col> Displayed to user </col> <col> OPN </col>
1154 The notification has been displayed to the user. It is not guaranteed that the user has read the notification, but he/she should be aware of it. The status will now be changed to <strong>OPEN</strong> if the current status is <strong>NEW</strong>.
1158 <col> 3 </col> <col> Remarks added </col> <col> PEN </col>
1160 Remarks have been added to the notification. The status has now been changed to <strong>PENDING</strong>.
1164 <col> 4 </col> <col> Priority changed manually </col> <col> PEN </col>
1166 The priority of the notification has been changed by the user. The new status is now <strong>PENDING</strong>.
1170 <col> 5 </col> <col> Priority changed automatically </col> <col> PEN </col>
1172 The priority of the notification has been changed by the system. If the status is not <strong>OPEN</strong> or <strong>NEW</strong> the new status is become <strong>PENDING</strong>.
1176 <col> 6 </col> <col> Action taken </col> <col> PEN </col>
1178 A action has been taken. The status is now <strong>PENDING</strong>.
1182 <col> 7 </col> <col> Assignment to user </col> <col> PEN </col>
1184 A notification has been explicitly assigned to another user. The status is now <strong>PENDING</strong>.
1188 <col> 8 </col> <col> More information or research needed. </col> <col> INV </col>
1190 The notification is relevant and will be handled, however more information or research will be needed. The status is <strong>UNDER INVESTIGATION</strong>.
1194 <col> 9 </col> <col> Make output reference. </col> <col> REF </col>
1196 Automated output from an object has been sent to gnucomo. The input has been identified as a valid reference for future. Status is now <strong>REFERENCE</strong><footnote>A reference is used to find differences in output. This feature must reduce the number of wrongful alerts. Only if a change has taken place a notification is generated. First time reports will always generate a notification. By signing this off the system will be silent again.</footnote>.
1200 <col> 10 </col> <col> Job output no longer reference. </col> <col> CLS </col>
1202 By making a newer job output reference this output has been obsoleted. Since once it was a reference the notification can be closed. The new status for the notification is now <strong>CLOSED</strong>.
1206 <col> 11 </col> <col> Action taken please verify. </col> <col> VRF </col>
1208 An action has been taken and things should have been resolved. Before the notification can be closed a verification has to be done. New status is now <strong>VERIFY</strong>.
1212 <col> 12 </col> <col> Action not accepted. </col> <col> PEN </col>
1214 A check has been done and the results were not good. New verification is needed. New status is now <strong>PENDING</strong>.
1218 <col> 13 </col> <col> Action verified </col> <col> CLS </col>
1220 The verification for the action has been done and the action is approved. The new status is now <strong>CLOSED</strong>.
1224 <col> 14 </col> <col> E-mail sent </col> <col> OPN<footnote>Only if the status is <strong>NEW</strong>.</footnote> </col>
1226 An e-mail has been sent.
1230 <col> 15 </col> <col> SMS sent </col> <col> OPN<footnote>Only if the status is <strong>NEW</strong>.</footnote> </col>
1232 A SMS has been sent.
1236 <col> 16 </col> <col> Fax sent </col> <col> OPN<footnote>Only if the status is <strong>NEW</strong>.</footnote> </col>
1238 A fax has been sent.
1242 <col> 17 </col> <col> Log-entries shown </col> <col> XXXX </col>
1244 The log entries have been shown. No changes to the status made.
1248 <col> 18 </col> <col> Notification closed </col> <col> CLS </col>
1250 Notification has been closed.
1254 <col> 19 </col> <col> Notification reopened </col> <col> OPN </col>
1256 Notification has been re-opened
1265 <heading>Action_notification_user.</heading>
1268 In the table action_notification_user each step that is taken regarding a
1269 notification is logged. This table is very important for later use if
1270 something goes wrong, but is also relevant for the interface.
1271 All steps of a notification can be traced here.
1272 There will be a lot of entries here, but retrieval is more crucial for
1273 performance than data entry. So indexing on logic fields is very relevant.
1274 Processing might be slower, but that's worth the price.
1278 <heading>The fields.</heading>
1281 The table below describes the fields:
1284 <table cpos='lllp{6cm}'>
1286 <col> Fieldname </col> <col> Fieldtype </col> <col> Size </col>
1292 <col> actionstepid </col> <col> Bigserial </col> <col> 8 </col>
1294 Autonumber bigint (eight bit)
1298 <col> actionid </col> <col> Bigint </col> <col> 8 </col>
1300 Reference to the action that is being registered here.
1304 <col> username </col> <col> Text </col> <col> <para/> </col>
1306 The username of the user that is involved in the action.
1310 <col> notificationid </col> <col> Bigint </col> <col> 8 </col>
1312 Reference to the notification.
1316 <col> timestamp </col> <col> Timestamp </col> <col> <para/> </col>
1318 The time when the action has been entered into the system. This is the time without the timezone<footnote>The timestamp without time has been selected, since this is the system time. To have the system functioning without any physical borders one of the settings on the system is time in GMT (UTC). This ensures also the added value of the system log.</footnote>. This will be automatically added when the record is added into the database.
1322 <col> statuscode </col> <col> Varchar </col> <col> 3 </col>
1324 The status of the Notification
1328 <col> remarks </col> <col> Text </col> <col> <para/> </col>
1330 Remarks entered by the user if it concerns a manual action or the text of automatically generated warnings.
1338 <heading>The indexes.</heading>
1341 The table is indexed on the following fields:
1346 <col> Indexname </col> <col> Field </col> <col> Characteristics </col>
1349 <col> anu_pk (action_user_actionstepid_key) </col> <col> actionstepid </col>
1350 <col> Primary key </col>
1353 <col> anu_actionid </col> <col> actionid </col> <col> <para/> </col>
1356 <col> anu_username </col> <col> username </col> <col> <para/> </col>
1359 <col> anu_notificationid </col> <col> notificationid </col> <col> <para/> </col>
1362 <col> anu_timestamp </col> <col> timestamp </col> <col> <para/> </col>
1365 <col> anu_statuscode </col> <col> statuscode </col> <col> <para/> </col>
1371 <heading>The relationships.</heading>
1374 Relationships with other tables:
1376 <table cpos='llp{7cm}'>
1378 <col> Fieldname </col> <col> Remote Table </col>
1379 <col> Remarks </col>
1382 <col> actionid </col> <col> action </col>
1384 Indicates the action that has been taken. The relationship has to be enforced.
1388 <col> notificationid </col> <col> notification </col>
1390 Each action that takes place is registered in this table. By using the notification the relevant notification. The relationship has to be enforced.
1394 <col> username </col> <col> user </col>
1396 Each step in the process has to be related to the user. If the system itself generates an action the user will be <strong>gnucomo</strong><footnote>This implies that the system automatically has an username gnucomo.</footnote>.
1402 In the model this looks like this:
1405 <picture src="erd-anu.png" eps="erd-anu"/>
1411 <heading>Sample data.</heading>
1414 Since no data is delivered automatically a couple of sample records are shown here.
1417 <table cpos='p{1cm}p{1cm}p{1cm}lllp{4cm}'>
1419 <col> Actionstepid </col> <col> Actionid </col> <col> Notificationid </col>
1420 <col> Username </col> <col> Timestamp </col> <col> Status </col>
1421 <col> Remarks </col>
1424 <col> 1 </col> <col> 1 </col> <col> 1 </col> <col> Gnucomo </col>
1425 <col> 2002-07-14 16:14:09 </col> <col> NEW </col>
1427 Gnucomo detected a portscan
1431 <col> 2 </col> <col> 5 </col> <col> 1 </col> <col> Gnucomo </col>
1432 <col> 2002-07-14 16:14:09 </col> <col> NEW </col>
1438 <col> 3 </col> <col> 5 </col> <col> 1 </col> <col> Gnucomo </col>
1439 <col> 2002-07-14 16:14:09 </col> <col> OPN </col>
1441 <para>Automatic e-mail to user: <reference href="mailto:brenno@dewinter.com">brenno@dewinter.com</reference>:</para>
1442 <para>Gnucomo detected a portscan on system <reference href="http://gnucomo.dewinter.com/">gnucomo.dewinter.com</reference></para>
1446 <col> 4 </col> <col> 2 </col> <col> 1 </col> <col> Brenno </col>
1447 <col> 2002-07-14 16:18:09 </col> <col> OPN </col>
1449 Notification shown through webinterface.
1453 <col> 5 </col> <col> 17 </col> <col> 1 </col> <col> Brenno </col>
1454 <col> 2002-07-14 16:18:12 </col> <col> PEN </col>
1460 <col> 6 </col> <col> 4 </col> <col> 1 </col> <col> Brenno </col>
1461 <col> 2002-07-14 16:20:37 </col> <col> PEN </col>
1467 <col> 7 </col> <col> 3 </col> <col> 1 </col> <col> Brenno </col>
1468 <col> 2002-07-1416:21:58 </col> <col> PEN </col>
1470 After reviewing the logs I see a portscan. On very specific ports. More analysis needed.
1474 <col> 8 </col> <col> 3 </col> <col> 1 </col> <col> Brenno </col>
1475 <col> 2002-07-14 16:24:59 </col> <col> PEN </col>
1477 Services tables learns me that all services are aimed at Windows-based services. Attempts for platform specific expoits.
1481 <col> 9 </col> <col> 4 </col> <col> 1 </col> <col> Brenno </col>
1482 <col> 2002-07-14 16:25:03 </col> <col> PEN </col>
1488 <col> 10 </col> <col> 2 </col> <col> 1 </col> <col> Brenno </col>
1489 <col> 2002-07-14 16:30:09 </col> <col> PEN </col>
1491 Notification shown through webinterface.
1495 <col> 11 </col> <col> 3 </col> <col> 1 </col> <col> Brenno </col>
1496 <col> 2002-07-14 16:31:48 </col> <col> PEN </col>
1498 Portscan has finished and no other action seems to take place now.
1502 <col> 12 </col> <col> 18 </col> <col> 1 </col> <col> Brenno </col>
1503 <col> 2002-07-14 16:43:03 </col> <col> CLS </col>
1513 <heading>log & log_adv. </heading>
1516 To store the log-data there are two tables in use that have a one-on-one relationship. The logic behind this is the difference between raw-always needed data and the somewhat processed data to support basic retrieval. The last category isn't always used and when it's used it is redundant. Also the raw log is very important to the integrity of the system. For these reasons the processed data has been physically separated in a second table called <emph>log_adv</emph>. If needed a view will be available that combines the two tables. Despite the load indexing on <emph>log_adv</emph> will be done thoroughly.
1521 <heading>log.</heading>
1524 <heading>The fields of log.</heading>
1527 The fields in log are focussed around the raw data and the data needed to link this to other tables in the system.
1530 <table cpos='lllp{6cm}'>
1532 <col> Fieldname </col> <col> Fieldtype </col> <col> Size </col>
1538 <col> logid </col> <col> Bigserial </col> <col> 8 </col>
1540 Autonumber bigint (eight bit)
1544 <col> objectid </col> <col> Bigint </col> <col> 8 </col>
1546 Reference to the object that submitted this log entry
1550 <col> original_filename </col> <col> Text </col> <col> <para/> </col>
1552 This field refers to the filename that contained this entry. The original entries as received by the gnucomo-server (flat files). The files are sent in batches, which makes it very hard to find where the original logline is. This will enable to see the files to detect bugs in gnucomo if any occur. It may well be that in a later stage this functionality becomes obsolete.
1556 <col> servicecode </col> <col> Text </col> <col> <para/> </col>
1558 This field explains what service was recognized (for instance 'kernel, 'httpd' or 'smtp')
1562 <col> type_of_logid </col> <col> Bigint </col> <col> 8 </col>
1564 Reference to the table type_of_log that contains information on what type of log/report we have here (how gnucomo recognized it).
1568 <col> object_timestamp </col> <col> Timestamp </col> <col> 8 </col>
1570 Timestamp as has been written into the log.
1574 <col> timestamp </col> <col> Timestamp </col> <col> <para/> </col>
1576 The time when the action has been entered into the system. This is the time without the timezone<footnote>The timestamp without time has been selected, since this is the system time. To have the system functioning without any physical borders one of the settings on the system is time in GMT (UTC). This ensures also the added value of the system log.</footnote>. This will be generated upon entry into the database.
1580 <col> rawdata </col> <col> TEXT </col> <col> <para/> </col>
1589 <heading>The indexes.</heading>
1592 The indices of the table:
1597 <col> Indexname </col> <col> Field </col> <col> Characteristics </col>
1600 <col> log_pk (log_logid_key) </col> <col> logid </col> <col> Primary key </col>
1603 <col> log_objectid </col> <col> objectid </col> <col> <para/> </col>
1606 <col> log_original_filename </col> <col> original_filename </col> <col> <para/> </col>
1609 <col> log_servicecode </col> <col> servicecode </col> <col> <para/> </col>
1612 <col> log_type_of_logid </col> <col> type_of_logid </col> <col> <para/> </col>
1615 <col> log_object_timestamp </col> <col> object_timestamp </col> <col> <para/> </col>
1618 <col> log_timestamp </col> <col> timestamp </col> <col> <para/> </col>
1624 <heading>The relationships.</heading>
1627 Relationships with other tables:
1630 <table cpos='llp{6cm}'>
1632 <col> Fieldname </col> <col> Remote Table </col>
1638 <col> objectid </col> <col> object </col>
1640 This make the link from what object the logline came
1644 <col> type_of_logid </col> <col> type_of_log </col>
1646 Each logbook has a certain type of reporting. This explains what type of log was received (and thus which rules for detection was applied).
1650 <col> systemuser </col> <col> user </col>
1652 Links a registered user of an object to this log entry<footnote>Upon entry of an object most of the times the passwd-file (UNIX-systems) or the userlist will serve as the entrypoint of users. Non existing users will be added and will have to be verified by an administrator before this entry become definite.</footnote>.
1657 <para>In the model this looks like this:</para>
1660 <picture src="erd-log.png" eps="erd-log"/>
1666 <heading>The fields of log_adv.</heading>
1669 The fields of the table <emph>log_adv</emph> are shown below:
1672 <table cpos='lllp{6cm}'>
1674 <col> Fieldname </col> <col> Fieldtype </col> <col> Size </col>
1680 <col> logid </col> <col> Bigint </col> <col> 8 </col>
1682 Bigint (eight bit) 1-to-1 relationship with log
1686 <col> source_ip </col> <col> Inet </col> <col> <para/> </col>
1688 This is the IP-address (V4) of the host that sended the data.
1692 <col> destination_ip </col> <col> Inet </col> <col> <para/> </col>
1694 This is the IP-address (V4) of the host that was targetted.
1698 <col> mac_address </col> <col> Macaddr </col> <col> <para/> </col>
1700 This is the MAC-address logged
1704 <col> packetlength </col> <col> Int </col> <col> <para/> </col>
1706 The length of the packet
1710 <col> protocol </col> <col> Text </col> <col> <para/> </col>
1712 The protocol used for transmission(mostly TCP/UDP/ICMP).
1716 <col> source_port </col> <col> Int </col> <col> <para/> </col>
1718 The portnumber used at origin.
1722 <col> destination_port </col> <col> Int </col> <col> <para/> </col>
1724 The portnumber for the target
1728 <col> messageid </col> <col> Text </col> <col> <para/> </col>
1730 Messageid for e-mails
1734 <col> system_username </col> <col> Text </col> <col> <para/> </col>
1736 Username on the object
1740 <col> networkdevice </col> <col> Text </col> <col> <para/> </col>
1742 When this is about network-traffic the device that worked the data
1749 <heading>The indexes.</heading>
1752 The table is indexed on the following fields:
1757 <col> Indexname </col> <col> Field </col> <col> Characteristics </col>
1760 <col> loa_logid </col> <col> logid </col> <col> Primary key </col>
1763 <col> loa_source_ip </col> <col> source_ip </col> <col> <para/> </col>
1766 <col> loa_destination_ip </col> <col> destination_ip </col> <col> <para/> </col>
1769 <col> loa_mac_address </col> <col> mac_address </col> <col> <para/> </col>
1772 <col> loa_packetlength </col> <col> packetlength </col> <col> <para/> </col>
1775 <col> loa_protocol </col> <col> protocol </col> <col> <para/> </col>
1778 <col> loa_source_port </col> <col> source_port </col> <col> <para/> </col>
1781 <col> loa_destination_port </col> <col> destination_port </col> <col> <para/> </col>
1784 <col> loa_messageid </col> <col> messageid </col> <col> <para/> </col>
1787 <col> loa_system_username </col> <col> system_username </col> <col> <para/> </col>
1790 <col> networkdevice </col> <col> networkdevice </col> <col> <para/> </col>
1796 <heading>The relationships.</heading>
1799 There is only one relation with this table.
1802 <table cpos='llp{6cm}'>
1804 <col> Fieldname </col> <col> Remote Table </col>
1810 <col> Logid </col> <col> Log </col>
1812 This will make a link to the table <emph>log</emph>. The relationship is a one-on-one relationship.
1819 <heading>Sample data combined from log and log_adv.</heading>
1822 The sample data derrived here has been gathered in logs. Since the tablestructure is very long the representation is somewhat different:
1825 <table cpos='lp{8cm}'>
1827 <col> Fieldname </col> <col> Value. </col>
1830 <col> Logid </col> <col> 1 </col>
1833 <col> Objectid </col> <col> 1 </col>
1836 <col> Original_filename </col> <col> 7f0100.messages.20020714231801 </col>
1839 <col> Rawdata </col>
1841 Jul 14 18:16:42 webber kernel: IN=eth0 OUT= MAC=00:60:67:36:61:a5:00:90:69:60:c0:5d:08:00 SRC=193.79.237.146 DST=212.204.216.11 LEN=40 TOS=0x00 PREC=0x00 TTL=245 id=19308 DF PROTO=TCP SPT=36375 DPT=113 WINDOW=8760 RES=0x00 RST URGP=0
1845 <col> Type_of_logid </col> <col> 1 </col>
1848 <col> Timestamp </col> <col> 2002-07-14 23:29:01 </col>
1851 <col> Object_timestamp </col> <col> 2002-07-14 18:16:42 </col>
1854 <col> Source_ip </col> <col> 193.79.237.146 </col>
1857 <col> Destination_ip </col> <col> 212.204.216.11 </col>
1860 <col> Mac_address </col> <col> 00:60:67:36:61:a5:00:90:69:60:c0:5d:08:00 </col>
1863 <col> Packetlength </col> <col> 40 </col>
1866 <col> Protocol </col> <col> TCP </col>
1869 <col> Source_port </col> <col> 36375 </col>
1872 <col> Destination_port </col> <col> 113 </col>
1875 <col> Messageid </col> <col> <para/> </col>
1878 <col> Systemuser </col> <col> <para/> </col>
1881 <col> Networkdevice </col> <col> eth0 </col>
1888 <heading>log_notification. </heading>
1891 In the log_notification the logbook entries that have caused an alert to occur are saved. When this table is used something has been detected. As this is clearly an intermediate table we anticipate to design checks where multiple entries in a log-file can lead to one notification. For forensics indexing will be focussed on retrieval speed.
1895 <heading>The fields.</heading>
1898 The fields are listed below:
1901 <table cpos='lllp{6cm}'>
1903 <col> Fieldname </col> <col> Fieldtype </col> <col> Size </col>
1909 <col> notificationid </col> <col> Bigint </col> <col> 8 </col>
1911 Reference to the notification
1915 <col> logid </col> <col> Bigint </col> <col> 8 </col>
1917 Reference to the logbook
1924 <heading>The indexes.</heading>
1927 The table is indexed on the following fields:
1931 <col> Indexname </col> <col> Field </col> <col> Characteristics </col>
1934 <col> lon_pk </col> <col>notificationid </col> <col>Primary key </col>
1937 <col> <para/> </col> <col>logid </col> <col>Primary key (second field) </col>
1940 <col>lon_notificationid </col> <col> notificationid </col> <col> <para/> </col>
1943 <col> lon_logid </col> <col>logid </col> <col> <para/> </col>
1949 <heading>The relationships.</heading>
1952 Relationships with other tables:
1955 <table cpos='llp{8cm}'>
1957 <col> Fieldname </col> <col> Remote Table </col>
1963 <col> Logid </col> <col> Log </col>
1965 Indicates the log-entry that was on of the triggers that led to the notification.
1969 <col> NotificationID </col> <col> Notification </col>
1971 Indicates the notification where the entry in the log was a trigger.
1976 <para>In the model this look like this:</para>
1978 <picture src="erd-lognotif.png" eps="erd-lognotif"/>
1983 <heading>Sample data.</heading>
1990 <col> LogID </col> <col> NotificationID </col>
1993 <col> 4 </col> <col> 1 </col>
1996 <col> 5 </col> <col> 1 </col>
1999 <col> 8 </col> <col> 1 </col>
2002 <col> 9 </col> <col> 1 </col>
2005 <col> 5 </col> <col> 2 </col>
2008 <col> 6 </col> <col> 2 </col>
2011 <col> 11 </col> <col> 2 </col>
2018 <heading>notification. </heading>
2021 In this table all detected issues per object will be written. Issues are entered based on immediate detection, periodical detection or manually. Since this table is mostly used to work from in the interface being in control is crucial. When systems function properly more retrieval than data entry will take place. Also data retrieval will be done in all sorts of ways. Indexing must be huge to facilitate that.
2025 <heading>The fields.</heading>
2028 The fields of the <emph>notification</emph> table are:
2031 <table cpos='lllp{6cm}'>
2033 <col> Fieldname </col> <col> Fieldtype </col> <col> Size </col>
2039 <col> notificationid </col> <col> Bigserial </col> <col> 8 </col>
2045 <col> objectid </col> <col> Bigint </col> <col> 8 </col>
2047 Reference to the <emph>object</emph>
2051 <col> type_of_notification_id </col> <col> Bigint </col> <col> 8 </col>
2053 Reference to the <emph>type_of_notification</emph> indicating what type of notification we have here and what basic rules apply.
2057 <col> timestamp </col> <col> Timestamp </col> <col> <para/> </col>
2059 Timestamp that this notification was created.
2063 <col> statuscode </col> <col> Varchar </col> <col> 3 </col>
2065 The status the actual status a notification has.
2069 <col> priority </col> <col> Int </col> <col> 4 </col>
2071 The priority that is given to this issue<footnote>Basically there will be five priority levels. The rule is that the lower the number gets the more urgent the issue is. At the moment the priority level is set by the system pre-defined actions will take place.</footnote>.
2075 <col> escalation_count_timestamp </col> <col> Timestamp </col> <col> <para/> </col>
2077 Timestamp since the last escalation took place<footnote>The system offers the possibility to automatically escalate issue if no action has been taken within a certain amount of time. Based on the status and the type of notification escalation can take place.</footnote>.
2081 <col> repeat_notification_timestamp </col> <col> Timestamp </col> <col> <para/> </col>
2083 Timestamp at which moment in time a repeat notification should occur<footnote>After this time has passed a notification is being resent. After a resent automatically a new time is set for another resent. If any actions takes place (except automated entries of course) the time is emptied so that an administrator will no longer be bothered by the system.</footnote>.
2087 <col> securitylevel_view </col> <col> Int </col> <col> 4 </col>
2089 The securitylevel that is needed to view this entry.
2093 <col> securitylevel_add </col> <col> Int </col> <col> 4 </col>
2095 Securitylevel to add information to this item or to undertake action
2099 <col> securitylevel_close </col> <col> Int </col> <col> 4 </col>
2101 The securitylevel needed to be able to close this notification.
2108 <heading>The indexes.</heading>
2115 <col> Indexname </col> <col> Field </col> <col> Characteristics </col>
2118 <col> not_pk (notification_notificationid_key) </col> <col> notificationid </col>
2119 <col> Primary key </col>
2122 <col> not_objectid </col> <col> objectid </col> <col> <para/> </col>
2125 <col> not_type_of_notificationid </col> <col> type_of_notificationid </col>
2126 <col> <para/> </col>
2129 <col> not_timestamp </col> <col> timestamp </col> <col> <para/> </col>
2132 <col> not_statuscode </col> <col> statuscode </col> <col> <para/> </col>
2135 <col> not_priority </col> <col> priority </col> <col> <para/> </col>
2138 <col> not_escalation_count_timestamp </col> <col> escalation_count_timestamp </col>
2139 <col> <para/> </col>
2143 <para>not_repeat_notification_timestamp</para>
2144 <para>(not_repeat_notification_timesta)</para>
2146 <col> repeat_notification_timestamp </col> <col> <para/> </col>
2152 <heading>The relationships.</heading>
2155 Relationships with other tables:
2158 <table cpos='llp{8cm}'>
2160 <col> Fieldname </col> <col> Remote Table </col> <col> Remarks </col>
2163 <col> Logid </col> <col> Log </col>
2165 Indicates the log-entry that was on of the triggers that led to the notification.
2169 <col> NotificationID </col> <col> Notification </col>
2171 Indicates the notification where the entry in the log was a trigger.
2176 <para>In the model this look like this:</para>
2178 <picture src="erd-notif.png" eps="erd-notif"/>
2183 <heading>Sample data.</heading>
2186 The following data is an example of a notification placed in the database.
2190 <col> Fieldname </col> <col> Data </col>
2193 <col> Notificationid </col> <col> 1 </col>
2196 <col> ObjectID </col> <col> 1 </col>
2199 <col> Type_of_notification_id </col> <col> 1 </col>
2202 <col> Timestamp </col> <col> 17-07-2002 16:07 </col>
2205 <col> Statuscode </col> <col> NEW </col>
2208 <col> Priority </col> <col> 3 </col>
2211 <col> Escalation_count_timestamp </col> <col> 17-07-2002 16:07 </col>
2214 <col> Repeat_notification_timestamp </col> <col> 17-07-2002 20:48PM </col>
2217 <col> Securitylevel_view </col> <col> 3 </col>
2220 <col> Securitylevel_add </col> <col> 3 </col>
2223 <col> Securitylevel_close </col> <col> 4 </col>
2230 <heading>object</heading>
2233 The <emph>object</emph> table contains general information on the objects being monitored. The table object will more be used for retrieval, since adding objects will be an occasional process. Anything that for some reason can be indexed ought to be indexed.
2237 <heading>The fields.</heading>
2242 <table cpos='lllp{6cm}'>
2244 <col> Fieldname </col> <col> Fieldtype </col> <col> Size </col>
2250 <col> objectid </col> <col> Bigserial </col> <col> 8 </col>
2252 Autonumbering code for the computer or device.
2256 <col> objectname </col> <col> Text </col> <col> <para/> </col>
2258 The hostname of the object
2262 <col> objectcode </col> <col> Text </col> <col> <para/> </col>
2264 Unique identifier (if existent) on the system<footnote>In Linux this will typically be the <emph>hostid</emph>.</footnote>.
2268 <col> scp_enabled </col> <col> Boolean </col> <col> <para/> </col>
2270 Can communication occur through scp (T = Yes / F = No)
2274 <col> scp_inet </col> <col> Inet </col> <col> <para/> </col>
2276 IP Address of the object for scp-data transfer.
2280 <col> mail_enabled </col> <col> Boolean </col> <col> <para/> </col>
2282 Can communication occur through e-mail (T = Yes/F = No).
2286 <col> mail_from </col> <col> Text </col> <col> <para/> </col>
2288 The e-mail address where e-mail will come from.
2292 <col> sms_enabled </col> <col> Boolean </col> <col> <para/> </col>
2294 Can communication occur through SMS (T = Yes/F = No).
2298 <col> sms_number </col> <col> Text </col> <col> <para/> </col>
2300 The SMS-number to send a notification to.
2304 <col> fax_enabled </col> <col> Boolean </col> <col> <para/> </col>
2306 Can communication occur through Fax (T = Yes/F = No).
2310 <col> fax_number </col> <col> Text </col> <col> <para/> </col>
2312 The fax-number to send a notification to.
2326 Description of the object. What type of system is it
2330 <col> object_owner </col> <col> Text </col> <col> <para/> </col>
2336 <col> physical_location </col> <col> Text </col> <col> <para/> </col>
2338 Physical address and when applicable entry-details needed to get to the object.
2342 <col> timezone </col> <col> Text </col> <col> <para/> </col>
2344 The timezone where this object is located<footnote>For objects that move around like PDA's and laptops the timezone can be the place where a person is stationed or better GMT.</footnote>.
2348 <col> remark </col> <col> Text </col> <col> <para/> </col>
2350 Additional remarks that shouldn't be in the previous TEXT fields.
2357 <heading>The indexes.</heading>
2360 The <emph>object</emph> table is indexed on the following fields:
2365 <col> Indexname </col> <col> Field </col> <col> Characteristics </col>
2368 <col> obj_pk (object_objectid_key) </col> <col> objectid </col> <col> Primary key </col>
2371 <col> obj_objectname </col> <col> objectname </col> <col> Unique </col>
2374 <col> obj_objectcode </col> <col> objectcode </col> <col> Unique </col>
2377 <col> obj_mail_from </col> <col> mail_from </col> <col> <para/> </col>
2383 <heading>The relationships.</heading>
2386 The relationships with other tables are listed below:
2389 <table cpos='llp{8cm}'>
2391 <col> Fieldname </col> <col> Remote Table </col> <col> Remarks </col>
2394 <col> ObjectID </col> <col> Log (adv) </col>
2395 <col> Reference to processed log-entries </col>
2398 <col> <para/> </col> <col> Notification </col>
2400 Reference to the table <emph>notification</emph> that contains the notifications that have been created.
2404 <col> <para/> </col> <col> Object_issue </col>
2406 Reference to the <emph>object_issue</emph> that indicates how notifications have to be handled .
2410 <col> <para/> </col> <col> Object_priority </col>
2412 Reference to the <emph>object_priority</emph> table that indicates how a certain level of priority has to be dealt with.
2416 <col> <para/> </col> <col> Object_system_user </col>
2418 Reference to a list of system user to discover abnormalities in user behaviour.
2422 <col> <para/> </col> <col> Object_user </col>
2423 <col> Reference to the <emph>object_user</emph> </col>
2426 <col> <para/> </col> <col> Unprocessed_log </col>
2428 Reference to the entries that have not been processed at all.
2433 <para>In the relationshipmodel this looks like this:</para>
2435 <picture src="erd-object.png" eps="erd-object"/>
2440 <heading>Sample data.</heading>
2442 There is no preset data and therefor it's an example has been created. The table has quite some fields so the example has the fieldname in the left column and the data in the right column.
2444 <table cpos='lp{6cm}'>
2447 <para>Fieldname</para>
2450 <para>Sample data</para>
2455 <para>Objectid</para>
2463 <para>Objectname</para>
2466 <para>webber.dewinter.com</para>
2471 <para>Objectcode</para>
2479 <para>Scp_enabled</para>
2487 <para>Scp_inet</para>
2490 <para>192.168.221.212</para>
2495 <para>Mail_enabled</para>
2503 <para>Mail_from</para>
2507 <reference href="mailto:gnucomo@maintenance.dewinter.com">gnucomo@maintenance.dewinter.com</reference>
2513 <para>Sms_enabled</para>
2521 <para>Sms_number</para>
2524 <para>06-XXXXXXXX</para>
2529 <para>Fax_enabled</para>
2537 <para>Fax_number</para>
2540 <para>0318-XXXXXX</para>
2545 <para>Object_description</para>
2548 <para>19 inch 4 units, AMD-300 with two 27Gb disks (RAID-0), 256Mb memory</para>
2553 <para>Object_owner</para>
2556 <para>Brenno de Winter</para>
2557 <para>De Winter Information Solutions</para>
2558 <para>Your street here 32</para>
2559 <para>9999 XX YOUR CITY</para>
2560 <para>THE NETHERLANDS</para>
2561 <para>Phone: +31 XXX XXX XXX</para>
2566 <para>Physical_location</para>
2569 <para>Internet Provider XYZ</para>
2570 <para>Your street here 38</para>
2571 <para>9999 XX YOUR CITY</para>
2572 <para>THE NETHERLANDS</para>
2573 <para>Phone: +31 XXX XXX XXX</para>
2575 <para>Dataroom. System: Q7845</para>
2583 <para>A replacement system is available at the office location. The following persons have been authorized to enter the data room at the ISP:</para>
2584 <para>* Arjen Baart</para>
2585 <para>* Peter Busser</para>
2586 <para>* Brenno de Winter</para>
2595 <heading>object_issue. </heading>
2597 This table will store the policy on a certain issue like the priority being recognized and special actions to take. Since policies are utilized by the systems continuously all other process will rely on this index, while users will change the values occasionally.
2601 <heading>The fields.</heading>
2604 The fields of <emph>object_issue</emph>:
2607 <table cpos='lllp{6cm}'>
2610 <para>Fieldname</para>
2613 <para>Fieldtype</para>
2619 <para>Remarks</para>
2624 <para>objectid</para>
2633 <para>Reference to the object</para>
2638 <para>type_of_notificationid</para>
2647 <para>Reference to the <emph>type_of_notification</emph> indicating what type of notification we have here and what basic rules apply.</para>
2652 <para>default_priority</para>
2661 <para>The priority that will be set automatically when this type of notification is entered into the system.</para>
2666 <para>escalation</para>
2669 <para>Boolean</para>
2675 <para>Will the system perform automatic escalation (T = Yes / F = No)</para>
2680 <para>escalation_time</para>
2689 <para>The time after which a higher priority is awarded to the notification.</para>
2694 <para>max_priority</para>
2703 <para>The maximum priority given to this type of notification.</para>
2708 <para>adjusted_setting</para>
2717 <para>Some checks can have a special settings (for instance alert after 5 failed login attempts instead of 3).</para>
2724 <heading>The indexes.</heading>
2727 These are the indices:
2732 <para>Indexname</para>
2738 <para>Characteristics</para>
2746 <para>objectid</para>
2749 <para>Primary key</para>
2757 <para>type_of_notification_id</para>
2760 <para>Primary key</para>
2765 <para>obi_objectid</para>
2768 <para>Objectid</para>
2776 <para>obi_type_of_notificationid</para>
2779 <para>type_of_notification_id</para>
2789 <heading>The relationships.</heading>
2792 Relationships with other tables:
2795 <table cpos='llp{6cm}'>
2798 <para>Fieldname</para>
2801 <para>Remote Table</para>
2804 <para>Remarks</para>
2809 <para>ObjectID</para>
2815 <para>Reference to the <emph>object</emph> (which object does this apply to).</para>
2820 <para>Type_of_issueid</para>
2823 <para>Type_of_issue</para>
2826 <para>Reference to the type of issue.</para>
2831 <para>In the model this look like this:</para>
2833 <picture src="erd-objissue.png" eps="erd-objissue"/>
2838 <heading>Sample data.</heading>
2843 <table cpos='lllllll'>
2846 <para>Objectid</para>
2849 <para>Type_of_notification_id</para>
2852 <para>Default Priority</para>
2855 <para>Escalation</para>
2858 <para>Escalation_time</para>
2861 <para>Max_priority</para>
2864 <para>Adjusted_setting</para>
2881 <para>00:15:00</para>
2904 <para>00:30:00</para>
2950 <para>00:45:00</para>
2987 <heading>object_priority. </heading>
2990 This table stores per object how a certain level of priority is being dealt with. What policies do apply. This table is mostly used for retrieval, so firm indexing is logic.
2994 <heading>The fields.</heading>
2997 The fields are listed below:
2999 <table cpos='lllp{6cm}'>
3002 <para>Fieldname</para>
3005 <para>Fieldtype</para>
3011 <para>Remarks</para>
3016 <para>objectid</para>
3025 <para>Reference to the object</para>
3030 <para>priorityid</para>
3039 <para>Priority.</para>
3044 <para>send_mail</para>
3047 <para>Boolean</para>
3053 <para>Send an e-mail if this priority is set? Yes = T / No = F</para>
3058 <para>send_sms</para>
3061 <para>Boolean</para>
3067 <para>Send a sms message if this priority is set? Yes = T / No = F</para>
3072 <para>send_fax</para>
3075 <para>Boolean</para>
3081 <para>Send a fax if this priority is set? Yes = T / No = F</para>
3086 <para>repeat_notification</para>
3089 <para>Boolean</para>
3095 <para>Repeat this notification if no action occurs since the notification. Yes = T / No = F</para>
3100 <para>interval_for_repeat</para>
3109 <para>Time interval that is set to wait for a response.</para>
3116 <heading>The indexes.</heading>
3119 Indices of the <emph>object_priority</emph> table:
3125 <para>Indexname</para>
3131 <para>Characteristics</para>
3139 <para>objectid</para>
3142 <para>Primary key</para>
3150 <para>priorityid</para>
3153 <para>Primary key</para>
3158 <para>obi_objectid</para>
3161 <para>Objectid</para>
3169 <para>obi_type_of_notification_id</para>
3172 <para>type_of_notification_id</para>
3182 <heading>The relationships.</heading>
3185 Relationships with other tables:
3188 <table cpos='llp{6cm}'>
3191 <para>Fieldname</para>
3194 <para>Remote Table</para>
3197 <para>Remarks</para>
3202 <para>ObjectID</para>
3208 <para>Reference to the object (which object does this apply to).</para>
3213 <para>Priorityid</para>
3216 <para>Priority</para>
3219 <para>Reference to the priority.</para>
3225 In the model this look like this:
3228 <picture src="erd-objprior.png" eps="erd-objprior"/>
3234 <heading>object_service</heading>
3237 The object service table indicates which services can be expected on the system If input fails to show up a notification can be generated.
3241 <heading>The fields.</heading>
3244 The fields are listed below:
3247 <table cpos='lllp{6cm}'>
3250 <para>Fieldname</para>
3253 <para>Fieldtype</para>
3259 <para>Remarks</para>
3264 <para>objectid</para>
3273 <para>Reference to the object</para>
3278 <para>servicecode</para>
3287 <para>Reference to service.</para>
3292 <para>expected_interval</para>
3301 <para>The expected interval in minutes between two log entries. If this gives a time-out a notification is generated<footnote>To avoid many false positives it may be wise to give the system always 1 or 2 minutes extra time. If for some reason a connection is slow or a mail-daemon restarted the effect would generate tuns of notifications.</footnote>. The following values can be considered the most common:</para>
3302 <para>* 60 hourly entries</para>
3303 <para>* 120 two hourly entries</para>
3304 <para>* 240 four hourly entries</para>
3305 <para>* 480 eight hourly entries</para>
3306 <para>* 920 twelve hourly entries</para>
3307 <para>* 1840 daily entries</para>
3308 <para>* 12880 weekly entries</para>
3313 <para>last_entry</para>
3316 <para>Timestamp</para>
3322 <para>The timestamp of the last entry (for detecting exceeded interval). This field could be derived from the log-table as well, but the redundance gives a performance on detection that is useful, since a check should run every minute.</para>
3327 <para>default_priority</para>
3336 <para>Priority given if this service didn't occur.</para>
3341 <para>maximum_priority</para>
3350 <para>Maximum priority (in case of escalation)</para>
3355 <para>accepted</para>
3358 <para>Boolean</para>
3364 <para>If a service hasn't been set, the application user should indicate that this is valid (logs shouldn't just appear). New entries will be added automatically but still have to be verified.</para>
3371 <heading>The indexes.</heading>
3374 The table is indexed on the following fields:
3379 <para>Indexname</para>
3385 <para>Characteristics</para>
3393 <para>objectid</para>
3396 <para>Primary key</para>
3404 <para>servicecode</para>
3407 <para>Primary key</para>
3412 <para>obs_objectid</para>
3415 <para>objectid</para>
3423 <para>obs_servicecode</para>
3426 <para>servicecode</para>
3434 <para>obs_accepted</para>
3437 <para>accepted</para>
3447 <heading>The relationships.</heading>
3450 Relationships with other tables:
3453 <table cpos='llp{8cm}'>
3456 <para>Fieldname</para>
3459 <para>Remote Table</para>
3462 <para>Remarks</para>
3467 <para>objectID</para>
3473 <para>Reference to the object (which object does this apply to).</para>
3478 <para>servicecode</para>
3481 <para>Service</para>
3484 <para>Reference to the service table. </para>
3489 <para>In the model this look like this:</para>
3491 <picture src="erd-objservice.png" eps="erd-objservice"/>
3497 <heading>object_system_user</heading>
3500 This table will derive a list of users that can be identified based on the log-files in the system. This table is filled during data entry. But the filling of the table is dependent on the fact if the user has been entered before. So during the processing the read will be done more than the data entry and that makes heavy indexing logic.
3503 <heading>The fields.</heading>
3506 The fields of <emph>object_system_user</emph> are listed below:
3509 <table cpos='lllp{6cm}'>
3512 <para>Fieldname</para>
3515 <para>Fieldtype</para>
3521 <para>Remarks</para>
3526 <para>objectid</para>
3535 <para>Reference to the object</para>
3540 <para>system_username</para>
3549 <para>Username on the object/system.</para>
3554 <para>can_login</para>
3557 <para>Boolean</para>
3563 <para>Can this user login (T = Yes / F = No)?</para>
3568 <para>can_be_root</para>
3571 <para>Boolean</para>
3577 <para>Can this user become root (T = Yes / F = No)?</para>
3584 <heading>The indexes.</heading>
3587 The table is indexed on the following fields:
3592 <para>Indexname</para>
3598 <para>Characteristics</para>
3606 <para>objectid</para>
3609 <para>Primary key</para>
3617 <para>system_username</para>
3620 <para>Primary key</para>
3625 <para>osu_objectid</para>
3628 <para>objectid</para>
3636 <para>osu_system_username</para>
3639 <para>system_username</para>
3649 <heading>The relationships.</heading>
3652 Relationships with other tables:
3654 <table cpos='llp{8cm}'>
3657 <para>Fieldname</para>
3660 <para>Remote Table</para>
3663 <para>Remarks</para>
3668 <para>ObjectID</para>
3674 <para>Reference to the object (which object does this apply to).</para>
3679 <para>System_username</para>
3685 <para>Log entries can refer to the system username.</para>
3689 <para>In the model this look like this:</para>
3693 <picture src="erd-objsysusr.png" eps="erd-objsysusr"/>
3699 <heading>object_user</heading>
3702 This table will enable users to get access to the information belonging to an object. Also this table is mainly used for data retrieval and will rely on the indexes.
3705 <heading>The fields.</heading>
3708 The fields of <emph>object_user</emph> are listed below:
3711 <table cpos='lllp{6cm}'>
3714 <para>Fieldname</para>
3717 <para>Fieldtype</para>
3723 <para>Remarks</para>
3728 <para>Objectid</para>
3737 <para>Reference to the <emph>object</emph></para>
3742 <para>Username</para>
3751 <para>Username in gnucomo. A reference to <emph>user</emph>.</para>
3756 <para>Security_level</para>
3765 <para>The security-level granted to this user.</para>
3772 <heading>The indexes.</heading>
3774 The indices of the <emph>object_user</emph> table:
3779 <para>Indexname</para>
3785 <para>Characteristics</para>
3793 <para>objectid</para>
3796 <para>Primary key</para>
3804 <para>username</para>
3807 <para>Primary key</para>
3812 <para>ous_objectid</para>
3815 <para>objectid</para>
3823 <para>ous_username</para>
3826 <para>username</para>
3834 <para>ous_security_level</para>
3837 <para>ous_security_level</para>
3847 <heading>The relationships.</heading>
3850 Relationshiips with other tables:
3853 <table cpos='llp{8cm}'>
3856 <para>Fieldname</para>
3859 <para>Remote Table</para>
3862 <para>Remarks</para>
3867 <para>objectID</para>
3873 <para>Reference to the object (which object does this apply to).</para>
3878 <para>username</para>
3884 <para>Reference to the user.</para>
3889 <para>In the model this look like this:</para>
3890 <picture src="erd-objusr.png" eps="erd-objusr"/>
3896 <heading>priority</heading>
3899 The priority table contains information on the levels that are recognized by the system. Mainly data retrieval so depending on indexing. It needs to be said that most likely only a couple of states will exist<footnote>By default we will use five states, but many states can be given to enable all types of differentiation.</footnote>.
3903 <heading>The fields.</heading>
3906 The fields of the <emph>priority</emph> table are listed below:
3909 <table cpos='lllp{6cm}'>
3912 <para>Fieldname</para>
3915 <para>Fieldtype</para>
3921 <para>Remarks</para>
3926 <para>priority</para>
3935 <para>Priority</para>
3940 <para>send_mail</para>
3943 <para>Boolean</para>
3949 <para>Send an e-mail if this priority is set? Yes = T / No = F</para>
3954 <para>send_sms</para>
3957 <para>Boolean</para>
3963 <para>Send a sms message if this priority is set? Yes = T / No = F</para>
3968 <para>send_fax</para>
3971 <para>Boolean</para>
3977 <para>Send a fax if this priority is set? Yes = T / No = F</para>
3982 <para>repeat_notification</para>
3985 <para>Boolean</para>
3991 <para>Repeat this notification if no action occurs since the notification. Yes = T / No = F</para>
3996 <para>interval_for_repeat</para>
4005 <para>Time interval that is set to wait for a response.</para>
4012 <heading>The indexes.</heading>
4015 The table is indexed on the following fields:
4021 <para>Indexname</para>
4027 <para>Characteristics</para>
4035 <para>priority</para>
4038 <para>Primary key</para>
4045 <heading>The relationships.</heading>
4048 Relationships with other tables:
4050 <table cpos='llp{8cm}'>
4053 <para>Fieldname</para>
4056 <para>Remote Table</para>
4059 <para>Remarks</para>
4064 <para>priority</para>
4067 <para>object_priority</para>
4070 <para>Reference to the object (which object does this apply to). </para>
4075 <para>In the model this look like this:</para>
4077 <picture src="erd-prior.png" eps="erd-prior"/>
4083 <heading>service</heading>
4086 The table <emph>service</emph> indicates the service that can be handled by the system. Out of the servicelist the administrator can indicate what services to expect.
4089 <heading>The fields.</heading>
4092 The fields are listed below:
4094 <table cpos='lllp{6cm}'>
4097 <para>Fieldname</para>
4100 <para>Fieldtype</para>
4106 <para>Remarks</para>
4111 <para>servicecode</para>
4120 <para>The code that is written for the service</para>
4125 <para>servicename</para>
4134 <para>The expanded name for the service</para>
4139 <para>default_priority</para>
4148 <para>The advised priority if these log-entries don't come in<footnote>Advised priorities can be changed in the object_service table per object. </footnote>.</para>
4153 <para>max_priority</para>
4162 <para>The maximum priority advised for this service<footnote>Advised priorities can be changed in the object_service table per object.</footnote>.</para>
4169 <heading>The indexes.</heading>
4172 The table is indexed on the following fields:
4177 <para>Indexname</para>
4183 <para>Characteristics</para>
4191 <para>servicecode</para>
4194 <para>Primary key</para>
4199 <para>ser_servicename</para>
4202 <para>servicename</para>
4212 <heading>The relationships.</heading>
4214 Relationships with other tables:
4216 <table cpos='llp{8cm}'>
4219 <para>Fieldname</para>
4222 <para>Remote Table</para>
4225 <para>Remarks</para>
4230 <para>servicecode</para>
4236 <para>What log entries have been tied to this type of service.</para>
4244 <para>object_service</para>
4247 <para>Settings for this service per object.</para>
4255 <para>unprocessed_log</para>
4258 <para>What unprocessed log entries have been tied to this type of service.</para>
4263 <para>In the model this look like this:</para>
4265 <picture src="erd-service.png" eps="erd-service"/>
4271 <heading>status.</heading>
4274 The table <emph>status</emph> contains the possible states that a notification can have. As with the table <emph>priority</emph> these statuses are limited in number by default but can be expanded. Also here retrieval prevails above data entry and therefor indexing is important.
4278 <heading>The fields.</heading>
4281 The fields of the <emph>status</emph> table are listed below:
4284 <table cpos='lllp{6cm}'>
4287 <para>Fieldname</para>
4290 <para>Fieldtype</para>
4296 <para>Remarks</para>
4301 <para>statuscode</para>
4304 <para>Varchar</para>
4310 <para>The code for the status</para>
4315 <para>statusname</para>
4324 <para>What is the correct name for the status</para>
4329 <para>open_notification</para>
4332 <para>Boolean</para>
4338 <para>Is the notification still open when this status is set? Yes = T / No = F</para>
4343 <para>description</para>
4352 <para>Explanation of the code</para>
4359 <heading>The indexes.</heading>
4361 The table is indexed on the following fields:
4367 <para>Indexname</para>
4373 <para>Characteristics</para>
4381 <para>statuscode</para>
4384 <para>Primary key</para>
4389 <para>sta_statusname</para>
4392 <para>statusname</para>
4400 <para>sta_open_notification</para>
4403 <para>open_notification</para>
4413 <heading>The relationships.</heading>
4415 Relationships with other tables
4421 <para>Fieldname</para>
4424 <para>Remote Table</para>
4427 <para>Remarks</para>
4442 <para>In the model this look like this:</para>
4444 <picture src="erd-status.png" eps="erd-status"/>
4449 <heading>Default values.</heading>
4450 <para>The status values are default for the system and for that reason are predefined.</para>
4451 <table cpos='p{2cm}lp{1cm}p{6cm}'>
4454 <para>Statuscode</para>
4457 <para>Statusname</para>
4460 <para>Open Notification</para>
4471 <para>New entry</para>
4477 <para>Just detected nothing has been done yet.</para>
4491 <para>The notification has been displayed, but nothing has been done yet.</para>
4499 <para>Pending</para>
4505 <para>The notification is currently being worked on.</para>
4513 <para>Waiting for verification</para>
4519 <para>The notification has been worked on. After it has been verified the notification can be closed.</para>
4533 <para>The notification has been closed</para>
4541 <para>Rejected</para>
4547 <para>This was a false positive and has been rejected.</para>
4555 <para>Investigate</para>
4561 <para>The notification is under investigation and awaiting additional details.</para>
4569 <heading>type_of_issue.</heading>
4571 <para>This table will contain a list of all available issues that can be detected. All issues have a suggested priority setting. This is typically data retrieval and good indexing is needed.</para>
4574 <heading>The fields.</heading>
4577 Fields of <emph>type_of_issue</emph> are:
4580 <table cpos='lllp{6cm}'>
4583 <para>Fieldname</para>
4586 <para>Fieldtype</para>
4592 <para>Remarks</para>
4597 <para>type_of_issueid</para>
4600 <para>Bigserial</para>
4606 <para>The sequential code for the issue.</para>
4620 <para>Name for the issue</para>
4625 <para>suggested_priority</para>
4634 <para>The advised priority setting.</para>
4639 <para>description</para>
4648 <para>Description of the method and how this can be set.</para>
4656 <para>Boolean</para>
4662 <para>Is this check currently being used in the system.</para>
4669 <heading>The indexes.</heading>
4671 The table is indexed on the following fields:
4677 <para>Indexname</para>
4683 <para>Characteristics</para>
4689 <para>(type_of_issue_type_of_issue_key)</para>
4692 <para>type_of_issueid</para>
4695 <para>Primary key</para>
4700 <para>toi_name</para>
4711 <para>toi_active</para>
4724 <heading>The relationships.</heading>
4728 <para>Fieldname</para>
4731 <para>Remote Table</para>
4734 <para>Remarks</para>
4739 <para>type_of_issueid</para>
4742 <para>object_issue</para>
4750 <para>In the model this look like this:</para>
4752 <picture src="erd-toi.png" eps="erd-toi"/>
4757 <heading>Default values.</heading>
4760 All checks are entered as code into the system. This table only works for the application only. The user can set specifics in the application only.
4762 <table cpos='lllll'>
4765 <para>Type_of_issueid</para>
4771 <para>Suggested_priority</para>
4774 <para>Description</para>
4785 <para>Manual entry</para>
4791 <para>A manual entry of a notification.</para>
4802 <heading>unprocessed_log</heading>
4805 The <emph>user</emph> table contains the users that can login the monitoring application. It will also store if the users maintains the system. Mainly used for retrieval so properly indexed.
4809 <heading>The fields.</heading>
4812 The fields are listed below:
4815 <table cpos='lllp{6cm}'>
4818 <para>Fieldname</para>
4821 <para>Fieldtype</para>
4827 <para>Remarks</para>
4832 <para>unprocessedid</para>
4835 <para>Bigserial</para>
4841 <para>Autonumber entry</para>
4846 <para>objectid</para>
4855 <para>Reference to the object</para>
4860 <para>servicecode</para>
4869 <para>The service that entered this data.</para>
4874 <para>logdata</para>
4883 <para>The data that comes from the file.</para>
4890 <heading>The indexes.</heading>
4892 The indices of the table:
4898 <para>Indexname</para>
4904 <para>Characteristics</para>
4910 <para>(unprocessed_l_unprocessedid_key)</para>
4913 <para>unprocessedid</para>
4916 <para>Primary key</para>
4923 <heading>The relationships.</heading>
4925 Relationships with other tables:
4928 <table cpos='llp{8cm}'>
4931 <para>Fieldname</para>
4934 <para>Remote Table</para>
4937 <para>Remarks</para>
4942 <para>objectid</para>
4948 <para>Reference to the object that is reporting the data</para>
4953 <para>servicecode</para>
4956 <para>service</para>
4959 <para>Reference to the servicecode that is mentioned in the filename.</para>
4963 <para>In the model this look like this:</para>
4965 <picture src="erd-unplog.png" eps="erd-unplog"/>
4970 <heading>Sample values.</heading>
4976 <heading>user_gnucomo</heading>
4978 <para>The <emph>user</emph> table contains the users that can login the monitoring application. It will also store if the users maintains the system. Mainly used for retrieval so properly indexed.</para>
4980 <heading>The fields.</heading>
4982 The fields are listed in the table below:
4985 <table cpos='lllp{6cm}'>
4988 <para>Fieldname</para>
4991 <para>Fieldtype</para>
4997 <para>Remarks</para>
5002 <para>username</para>
5011 <para>Name the user is known by</para>
5016 <para>password</para>
5025 <para>Password</para>
5030 <para>active_sessionid</para>
5039 <para>Sessionnumber currently used by user. If this is set to 0 a user is not present on the system. Only one session can be open at a time.</para>
5044 <para>account_active</para>
5047 <para>Boolean</para>
5053 <para>Is the account currently active?</para>
5058 <para>security_level</para>
5067 <para>Given securitylevel to this user</para>
5074 <heading>The indexes</heading>
5076 The table is indexed on the following fields:
5081 <para>Indexname</para>
5087 <para>Characteristics</para>
5095 <para>username</para>
5098 <para>Primary key</para>
5103 <para>usr_active_sessionid</para>
5106 <para>active_sessionid</para>
5116 <heading>The relationships.</heading>
5118 Relationships with other tables
5123 <para>Fieldname</para>
5126 <para>Remote Table</para>
5129 <para>Remarks</para>
5134 <para>ObjectID</para>
5140 <para>Link to the object</para>
5144 <para>In the model this look like this:</para>
5146 <picture src="erd-usr.png" eps="erd-usr"/>
5153 <heading>Model of table-relations.</heading>
5155 <para>The following model pictures the database as it has been described before.</para>
5157 <picture src="erd.png" eps="erd" scale="0.7"/>
5164 <heading>Warnings that can be detected.</heading>
5168 <heading>User Interface.</heading>
5170 <para>To be determined in the near future.</para>
5174 <heading>The installation process.</heading>
5176 <para>Since the system must make maintenance and security easier to use, the burden of installation should as easy as possible. Where possible the installation script should take away as much work as possible. Where settings need to be done, this should be done through an interface. However at no point we take the user's right to understand and work with system. Configuration-files should be easy to understand and the choice must be there to do installation manually. </para>
5179 <heading>Supported platforms.</heading>
5181 <para>The following two Linux distributions have been selected to be actively supported:</para>
5184 <para>Debian GNU/Linux (.deb packages)</para>
5187 <para>RedHat Linux (.rpm packages)</para>
5190 <para>We will try and facilitate as many operating systems client-side and as many unices server-side, but efforts on testing out of the projects will be very minimalistic to ensure that the project keeps delivering new version and new features. </para>
5194 <heading>Installation on the server.</heading>
5196 <para>The following steps will be part of a script, that can automatically perform these steps:</para>
5200 <para>Create the user <emph>gnucomo</emph>.</para>
5203 <para>Make the directory as described in the chapter <emph>Sending messages to the central gnucomo system</emph> in the subchapter <emph>directories</emph>.(server-side).</para>
5209 <heading>Installation on a UNIX-client.</heading>
5211 <para>The following steps will be part of a script, that can automatically perform these steps:</para>
5214 <para>Create the user <emph>gcm_client</emph>.</para>
5217 <para>Make the directory as described in the chapter <emph>Sending messages to the central gnucomo system</emph> in the subchapter <emph>directories</emph> (client-side).</para>
5220 <para>Creation of the database user gcm_input. This user has only the right to enter data into the database. There are no deletion, update or select-permissions.</para>
5228 <heading>Dependency on other free software.</heading>
5230 <para>The following list is a set of applications that will be used on to make our application work:</para>
5231 <table cpos='lp{8cm}l'>
5234 <para>Application</para>
5237 <para>Needed for</para>
5240 <para>Client/Server</para>
5248 <para>The encryption of the information being transferred between the two systems.</para>
5257 <para>GNU/Linux</para>
5260 <para>The basic operating system. Allthough the system might work very well on all types on versions of Linux, FreeBSD, OpenBSD or any unices the main focus for distribution is given to: Debian GNU/Linux and RedHat Linux (the downloadable iso-version). </para>
5271 <para>The application enabling the sending of messages.</para>
5280 <para>openssh</para>
5283 <para>If e-mail is not used this application will deliver the file-copy</para>
5292 <para>PostgreSQL</para>
5295 <para>The database where all the signals from client will be stored.</para>
5303 <heading>Related projects</heading>
5306 There are a number of projects that can help <strong>Gnucomo</strong> or perform
5311 <reference href='http://crm114.sourceforge.net/'>CRM114</reference> - The Controllable
5320 <heading>Settings on the server machine.</heading>
5323 <heading>Required.</heading>
5325 <para>The following settings are required to ensure that the functionality is as much as expected.</para>
5328 <heading>Timezone in GMT (UTC).</heading>
5330 <para>Since all international traffic registers all entries in UTC (Universal Time Coordinate) this system will do so as well. Therefore the clock has to be adjusted to that as well as the system settings.</para>
5331 <para>These settings can found on a RedHat computer in the <code>/etc/sysconfig/clock-file</code>. On Debian this stored in the file <code>/etc/timezone</code>.</para>
5336 <heading>Suggested.</heading>
5339 <heading>Use NTP.</heading>
5341 <para>If a computer is running for some time the clocks tend to be off the correct time. This makes it harder to detect what exactly happened exactly at what moment in time and reduce value of log-entries. Especially considering that ultimately all data is gathered in one central system. To overcome this Network Time Protocol (NTP RFC 13025 March 1992) has been created that explains a protocol to synchronize clocks through the Internet. Many operating systems like Microsoft Windows 2000 Server and FreeBSD, OpenBSD and Linux support this. A ntp-server (or ntpd) can be found at: http://www.eecis.udel.edu/~ntp/ It is strongly recommended that you use this.</para>
5348 <heading>Settings on the client machine.</heading>
5351 <heading>Required.</heading>
5355 <heading>Suggested.</heading>
5358 <heading>Use NTP.</heading>
5360 <para>If a computer is running for some time the clocks tend to be off the correct time. This makes it harder to detect what exactly happened exactly at what moment in time and reduce value of log-entries. Especially considering that ultimately all data is gathered in one central system. To overcome this Network Time Protocol (NTP RFC 13025 March 1992) has been created that explains a protocol to synchronize clocks through the Internet. Many operating systems like Microsoft Windows 2000 Server and FreeBSD, OpenBSD and Linux support this. A ntp-server (or ntpd) can be found at: http://www.eecis.udel.edu/~ntp/ It is strongly recommended that you use this.</para>
5367 <heading>Appendices.</heading>
5370 <heading>Appendix A. GNU Public License Version 2, June 1991.</heading>
5372 <para>Copyright (C) 1989, 1991 Free Software Foundation, Inc.</para>
5373 <para>59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</para>
5374 <para>Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.</para>
5377 <heading>Preamble</heading>
5378 <para>The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Library General Public License instead.) You can apply it to your programs, too. </para>
5379 <para>When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things.</para>
5380 <para>To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it.</para>
5381 <para>For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights.</para>
5382 <para>We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. </para>
5383 <para>Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations.</para>
5384 <para>Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all.</para>
5385 <para>The precise terms and conditions for copying, distribution and modification follow.</para>
5386 <para>GNU GENERAL PUBLIC LICENSE</para>
5390 <heading>TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION</heading>
5394 <para>This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you".</para>
5395 <para>Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does. </para>
5398 <para>You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program.</para>
5399 <para>You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee.</para>
5402 <para>You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions:</para>
5403 <para>a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change.</para>
5404 <para>b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License.</para>
5405 <para>c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.)</para>
5406 <para>These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it.</para>
5407 <para>Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program.</para>
5408 <para>In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License.</para>
5411 <para>You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following:</para>
5412 <para>a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, </para>
5413 <para>b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or,</para>
5414 <para>c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.)</para>
5415 <para>The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable.</para>
5416 <para>If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code.</para>
5419 <para>You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance.</para>
5422 <para>You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it.</para>
5425 <para>Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein.</para>
5426 <para>You are not responsible for enforcing compliance by third parties to this License.</para>
5429 <para>If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program.</para>
5430 <para>If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances.</para>
5431 <para>It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice.</para>
5432 <para>This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License.</para>
5435 <para>If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License.</para>
5438 <para>The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.</para>
5439 <para>Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation.</para>
5442 <para>If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally.</para>
5447 <heading>NO WARRANTY</heading>
5450 <para>BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVidE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.</para>
5453 <para>IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.</para>
5456 <para>END OF TERMS AND CONDITIONS</para>
5459 <heading>How to Apply These Terms to Your New Programs</heading>
5460 <para>If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. </para>
5461 <para>To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found.</para>
5462 <para><one line to give the program's name and a brief idea of what it does.> Copyright (C) <year> <name of author> This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.</para>
5463 <para>This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.</para>
5464 <para>You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</para>
5465 <para>Also add information on how to contact you by electronic and paper mail.</para>
5466 <para>If the program is interactive, make it output a short notice like this when it starts in an interactive mode:</para>
5467 <para>Gnomovision version 69, Copyright (C) year name of author</para>
5468 <para>Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.</para>
5469 <para>This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details.</para>
5471 <para>The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program.</para>
5472 <para>You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here is a sample; alter the names:</para>
5473 <para>Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (which makes passes at compilers) written by James Hacker. </para>
5474 <para><signature of Ty Coon>, 1 April 1989 Ty Coon, President of Vice</para>
5475 <para>This General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Library General Public License instead of this License.</para>
projects / gnucomo.git / blob