diff --git a/.bowerrc b/.bowerrc new file mode 100644 index 00000000..ba0accc5 --- /dev/null +++ b/.bowerrc @@ -0,0 +1,3 @@ +{ + "directory": "app/bower_components" +} diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 00000000..21256661 --- /dev/null +++ b/.gitattributes @@ -0,0 +1 @@ +* text=auto \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..5322511f --- /dev/null +++ b/.gitignore @@ -0,0 +1,10 @@ +*~ +*.iml +/.idea +node_modules +dist +.tmp +.sass-cache +app/bower_components +/nbproject/private/ +/app/config.js diff --git a/.jshintrc b/.jshintrc new file mode 100644 index 00000000..40377ba2 --- /dev/null +++ b/.jshintrc @@ -0,0 +1,24 @@ +{ + "node": true, + "browser": true, + "esnext": true, + "bitwise": true, + "camelcase": true, + "curly": true, + "eqeqeq": true, + "immed": true, + "indent": 2, + "latedef": true, + "newcap": true, + "noarg": true, + "quotmark": "single", + "regexp": true, + "undef": true, + "unused": true, + "strict": true, + "trailing": true, + "smarttabs": true, + "globals": { + "angular": false + } +} diff --git a/Gruntfile.js b/Gruntfile.js new file mode 100644 index 00000000..92f0acca --- /dev/null +++ b/Gruntfile.js @@ -0,0 +1,395 @@ +// Generated on 2014-04-25 using generator-angular 0.8.0 +'use strict'; + +// # Globbing +// for performance reasons we're only matching one level down: +// 'test/spec/{,*/}*.js' +// use this if you want to recursively match all subfolders: +// 'test/spec/**/*.js' + +module.exports = function (grunt) { + + var pkg = grunt.file.readJSON('package.json'); + var dist = "evebox-" + pkg.version; + + // Load grunt tasks automatically + require('load-grunt-tasks')(grunt); + + // Time how long tasks take. Can help when optimizing build times + require('time-grunt')(grunt); + + // Define the configuration for all the tasks + grunt.initConfig({ + + // Project settings + yeoman: { + // configurable paths + app: require('./bower.json').appPath || 'app', + dist: 'dist' + }, + + // Watches files for changes and runs tasks based on the changed files + watch: { + bower: { + files: ['bower.json'], + tasks: ['bowerInstall'] + }, + js: { + files: ['<%= yeoman.app %>/scripts/{,*/}*.js'], + tasks: ['newer:jshint:all'], + options: { + livereload: true + } + }, + styles: { + files: ['<%= yeoman.app %>/styles/{,*/}*.css'], + tasks: ['newer:copy:styles', 'autoprefixer'] + }, + gruntfile: { + files: ['Gruntfile.js'] + }, + livereload: { + options: { + livereload: '<%= connect.options.livereload %>' + }, + files: [ + '<%= yeoman.app %>/{,*/}*.html', + '.tmp/styles/{,*/}*.css', + '<%= yeoman.app %>/images/{,*/}*.{png,jpg,jpeg,gif,webp,svg}' + ] + } + }, + + // The actual grunt server settings + connect: { + options: { + port: 9000, + // Change this to '0.0.0.0' to access the server from outside. + hostname: 'localhost', + livereload: 35729 + }, + livereload: { + options: { + open: true, + base: [ + '.tmp', + '<%= yeoman.app %>' + ] + } + }, + dist: { + options: { + base: '<%= yeoman.dist %>' + } + }, + test: { + options: { + port: 9001, + base: [ + '.tmp', + 'test', + '<%= yeoman.app %>' + ] + } + } + }, + + // Make sure code styles are up to par and there are no obvious mistakes + jshint: { + options: { + jshintrc: '.jshintrc', + reporter: require('jshint-stylish') + }, + all: [ + 'Gruntfile.js', + '<%= yeoman.app %>/scripts/{,*/}*.js' + ], + }, + + // Empties folders to start fresh + clean: { + dist: { + files: [ + { + dot: true, + src: [ + '.tmp', + '<%= yeoman.dist %>/*', + '!<%= yeoman.dist %>/.git*' + ] + } + ] + }, + server: '.tmp' + }, + + // Add vendor prefixed styles + autoprefixer: { + options: { + browsers: ['last 1 version'] + }, + dist: { + files: [ + { + expand: true, + cwd: '.tmp/styles/', + src: '{,*/}*.css', + dest: '.tmp/styles/' + } + ] + } + }, + + // Automatically inject Bower components into the app + bowerInstall: { + app: { + src: ['<%= yeoman.app %>/index.html'], + ignorePath: '<%= yeoman.app %>/' + } + }, + + // Renames files for browser caching purposes + rev: { + dist: { + files: { + src: [ + '<%= yeoman.dist %>/scripts/{,*/}*.js', + '<%= yeoman.dist %>/styles/{,*/}*.css', + '<%= yeoman.dist %>/images/{,*/}*.{png,jpg,jpeg,gif,webp,svg}', + '<%= yeoman.dist %>/styles/fonts/*' + ] + } + } + }, + + // Reads HTML for usemin blocks to enable smart builds that automatically + // concat, minify and revision files. Creates configurations in memory so + // additional tasks can operate on them + useminPrepare: { + html: '<%= yeoman.app %>/index.html', + options: { + dest: '<%= yeoman.dist %>', + flow: { + html: { + steps: { + js: ['concat', 'uglifyjs'], + css: ['cssmin'] + }, + post: {} + } + } + } + }, + + // Performs rewrites based on rev and the useminPrepare configuration + usemin: { + html: ['<%= yeoman.dist %>/{,*/}*.html'], + css: ['<%= yeoman.dist %>/styles/{,*/}*.css'], + options: { + assetsDirs: ['<%= yeoman.dist %>'] + } + }, + + // The following *-min tasks produce minified files in the dist folder + cssmin: { + }, + + imagemin: { + dist: { + files: [ + { + expand: true, + cwd: '<%= yeoman.app %>/images', + src: '{,*/}*.{png,jpg,jpeg,gif}', + dest: '<%= yeoman.dist %>/images' + } + ] + } + }, + + svgmin: { + dist: { + files: [ + { + expand: true, + cwd: '<%= yeoman.app %>/images', + src: '{,*/}*.svg', + dest: '<%= yeoman.dist %>/images' + } + ] + } + }, + + htmlmin: { + dist: { + options: { + collapseWhitespace: true, + collapseBooleanAttributes: true, + removeCommentsFromCDATA: true, + removeOptionalTags: true + }, + files: [ + { + expand: true, + cwd: '<%= yeoman.dist %>', + src: ['*.html', 'views/{,*/}*.html'], + dest: '<%= yeoman.dist %>' + } + ] + } + }, + + // ngmin tries to make the code safe for minification automatically by + // using the Angular long form for dependency injection. It doesn't work on + // things like resolve or inject so those have to be done manually. + ngmin: { + dist: { + files: [ + { + expand: true, + cwd: '.tmp/concat/scripts', + src: '*.js', + dest: '.tmp/concat/scripts' + } + ] + } + }, + + // Copies remaining files to places other tasks can use + copy: { + dist: { + files: [ + { + expand: true, + dot: true, + cwd: '<%= yeoman.app %>', + dest: '<%= yeoman.dist %>', + src: [ + '*.{ico,png,txt}', + '.htaccess', + '*.html', + 'views/{,*/}*.html', + 'images/{,*/}*.{webp}', + 'fonts/*', + 'sample-config.js' + ] + }, + { + expand: true, + cwd: '.tmp/images', + dest: '<%= yeoman.dist %>/images', + src: ['generated/*'] + }, + + // add this rule to copy the fonts: + { + expand: true, + flatten: true, + cwd: '<%= yeoman.app %>', + dest: '<%= yeoman.dist %>/fonts', + src: ['bower_components/bootstrap/dist/fonts/*.*'] + }, + + { + expand: true, + cwd: '.', + dest: '<%= yeoman.dist %>', + src: ["README.md", "LICENSE.txt"] + } + + ] + }, + styles: { + expand: true, + cwd: '<%= yeoman.app %>/styles', + dest: '.tmp/styles/', + src: '{,*/}*.css' + } + }, + + // Run some tasks in parallel to speed up the build process + concurrent: { + server: [ + 'copy:styles' + ], + dist: [ + 'copy:styles', + 'imagemin', + 'svgmin' + ], + test: [ + 'copy:styles' + ] + }, + + compress: { + build: { + options: {archive: 'build/' + dist + '.zip', mode: 'zip'}, + src: ['**'], cwd: 'dist', expand: true, dot: true, dest: dist + '/' + } + }, + + // Test settings + karma: { + unit: { + configFile: 'karma.conf.js', + singleRun: true + } + } + + }); + + grunt.registerTask('serve', function (target) { + if (target === 'dist') { + return grunt.task.run(['build', 'connect:dist:keepalive']); + } + + grunt.task.run([ + 'clean:server', + 'bowerInstall', + 'concurrent:server', + 'autoprefixer', + 'connect:livereload', + 'watch' + ]); + }); + + grunt.registerTask('server', function (target) { + grunt.log.warn('The `server` task has been deprecated. Use `grunt serve` to start a server.'); + grunt.task.run(['serve:' + target]); + }); + + grunt.registerTask('test', [ + 'clean:server', + 'concurrent:test', + 'autoprefixer', + 'connect:test', + 'karma' + ]); + + grunt.registerTask('build', [ + 'clean:dist', + 'bowerInstall', + 'useminPrepare', + 'concurrent:dist', + 'autoprefixer', + 'concat', + 'ngmin', + 'copy:dist', + 'cssmin', + 'uglify', + 'rev', + 'usemin', + 'htmlmin' + ]); + + grunt.registerTask('default', [ + 'newer:jshint', + 'build' + ]); + + grunt.registerTask("package", [ + "build", + "compress" + ]); +}; diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 00000000..94a9ed02 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + 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 +them 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. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. 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. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey 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; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If 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 convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU 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. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + 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. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +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. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + 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. + + 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 +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + 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 3 of the License, or + (at your option) any later version. + + 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. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU 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 Lesser General +Public License instead of this License. But first, please read +. diff --git a/Makefile b/Makefile new file mode 100644 index 00000000..7019e4c8 --- /dev/null +++ b/Makefile @@ -0,0 +1,16 @@ +all: + +clean: + -grunt clean + find . -name \*~ -exec rm -f {} \; + rm -rf dist + rm -rf build + +clean-all: + -$(MAKE) clean + rm -rf node_modules + rm -rf app/bower_components + +setup: + npm install + bower install diff --git a/README.md b/README.md new file mode 100644 index 00000000..55396875 --- /dev/null +++ b/README.md @@ -0,0 +1,61 @@ +# EveBox + +EveBox is a Suricata "eve" event viewer for Elastic Search. + +# Requirements + +- Suricata, Logstash and Elastic Search. +- A webserver. EveBox consists of static files only. Apache, Nginx + or any other static file webserver will do. +- A modern browser. + +# Installation. + +1. Get the latest release from https://github.com/jasonish/evebox/releases. +2. Extract evebox-.zip to your webserver. +3. Optionally copy sample-config.js to config.js and modify. The + Elastic Search settings can also be set from the user interface, + but will need to be done from each browser. + +# Suricata / Logstash Setup + +EveBox currently works around the concept of an inbox. That is, events +go into the inbox until they are archive (acknowledged) or deleted. +This is done by adding the "inbox" tag to events with Logstash. + +Currently EveBox really only works with event_type alert, so to have +all new alerts show up in the inbox a Logstash filter like the +following can be added: + + filter { + + # Add the "inbox" tag to all incoming alerts. + if [event_type] == "alert" { + mutate { + add_tag => ["inbox"] + } + } + + } + +# Usage + +EveBox is built around keyboard shorcuts. Hit the "Help" link or +simply type "?" to get a list of keyboard shortcuts. If you are +familiar with GMail keyboard shortcuts it should feel familiar very +quickly. + +# TODOs +- Support for any "eve" record type. +- A better event "detail" view. +- Include 'vendor' sources so a git clone is immediately usable + (currently using what "yo angular" spit out with minor + modification). +- A darker theme. +- Arbitrary tagging. +- A backend might be needed to do such things as large bulk tagging. +- Be more "angular". + +# License + +For now, GPL v3. diff --git a/app/.buildignore b/app/.buildignore new file mode 100644 index 00000000..fc98b8eb --- /dev/null +++ b/app/.buildignore @@ -0,0 +1 @@ +*.coffee \ No newline at end of file diff --git a/app/index.html b/app/index.html new file mode 100644 index 00000000..99027b77 --- /dev/null +++ b/app/index.html @@ -0,0 +1,105 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/app/robots.txt b/app/robots.txt new file mode 100644 index 00000000..94174950 --- /dev/null +++ b/app/robots.txt @@ -0,0 +1,3 @@ +# robotstxt.org + +User-agent: * diff --git a/app/sample-config.js b/app/sample-config.js new file mode 100644 index 00000000..c257cb3c --- /dev/null +++ b/app/sample-config.js @@ -0,0 +1,25 @@ +/** + * Sample configuration file - THIS FILE SUBJECT TO CHANGE. + * + * Copy to "config.js" before editing. + */ +config = { + + // Elastic Search configuration. + // + // This can also be configured via the web interface and it will be stored + // in local storage. + elasticSearch: { + url: "http://" + window.location.hostname + ":9200", + size: 100 + }, + + // If URL is set, will add a "Send to Dumpy" button. + // + // This should turn into a list of configurable items you can "send" an + // event to. + dumpy: { + url: null + } + +}; diff --git a/app/scripts/app.js b/app/scripts/app.js new file mode 100644 index 00000000..ee8dbef2 --- /dev/null +++ b/app/scripts/app.js @@ -0,0 +1,512 @@ +/* + * Copyright (c) 2014 Jason Ish + * All rights reserved. + */ + +/* + * 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 3 of the License, or + * (at your option) any later version. + * + * 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. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +/* + * TODO: + * - Normalize on "hit", or "result" or "entry" or "event". + * - Don't do DOM manipulation in controllers. + */ + +var NAV_BAR_HEIGHT = 60; + +var app = angular.module("app", [ + "ngRoute", "ngResource", "ui.bootstrap", "ui.bootstrap.pagination"]); + +app.config(function ($routeProvider) { + + $routeProvider.when("/:view", { + controller: "MainController", + templateUrl: "views/main.html" + }); + + $routeProvider.otherwise({redirectTo: "/inbox"}); + +}); + +app.controller("NavBarController", function ($routeParams, $scope, $modal, $location, Keyboard) { + + $scope.$routeParams = $routeParams; + + $scope.openConfig = function () { + $modal.open({ + templateUrl: "views/config.html", + controller: "ConfigController" + }); + }; + + $scope.openHelp = function () { + $modal.open({ + templateUrl: "views/help.html", + size: "lg" + }); + } + + Keyboard.scopeBind($scope, "g i", function (e) { + $location.url("/inbox"); + $scope.$apply(); + }); + + Keyboard.scopeBind($scope, "g s", function (e) { + $location.url("/starred"); + $scope.$apply(); + }); + + Keyboard.scopeBind($scope, "g a", function (e) { + $location.url("/all"); + $scope.$apply(); + }); + + Keyboard.scopeBind($scope, "g c", function (e) { + $scope.openConfig(); + }); + + Keyboard.scopeBind($scope, "?", function (e) { + $scope.openHelp(); + }) +}); + +app.controller("ConfigController", function ($scope, $modalInstance, Config) { + + $scope.config = Config; + + $scope.ok = function () { + Config.save(); + $modalInstance.close(); + }; + + $scope.cancel = function () { + $modalInstance.dismiss(); + }; + +}); + +app.controller('MainController', function (Keyboard, $route, $location, $timeout, $routeParams, $scope, $http, $filter, Config, ElasticSearch) { + + // Debugging. + scope = $scope; + scope.Config = Config; + scope.ElasticSearch = ElasticSearch; + scope.filter = $filter; + scope.$http = $http; + scope.$routeParams = $routeParams; + scope.Keyboard = Keyboard; + scope.$location = $location; + scope.$route = $route; + + // Initial state. + $scope.state = "loading"; + $scope.errorMessage = ""; + $scope.page = 1; + $scope.userQuery = ""; + $scope.currentSelectionIdx = 0; + + if ($routeParams.view == "inbox") { + $scope.queryPrefix = "(event_type:alert AND tags:inbox)"; + } + else if ($routeParams.view == "starred") { + $scope.queryPrefix = "(event_type:alert AND tags:starred)"; + } + else { + $scope.queryPrefix = "(event_type:alert)"; + } + + $scope.buildQuery = function () { + + if ($scope.userQuery != "") { + return $scope.queryPrefix + " AND (" + $scope.userQuery + ")"; + } + else { + return $scope.queryPrefix; + } + + //return "event_type:alert AND " + $scope.userQuery; + if ($scope.userQuery != "") { + return "(event_type:alert AND tags:inbox) AND (" + $scope.userQuery + ")"; + } + else { + return "(event_type:alert AND tags:inbox)"; + } + }; + + $scope.displayErrorMessage = function (msg) { + $scope.errorMessage = msg; + $("#errorMessage").fadeIn(); + $("#errorMessage").delay(3000).fadeOut("slow"); + } + + $scope.toggleStar = function (item) { + if (item._source.tags.indexOf("starred") < 0) { + item._source.tags.push("starred"); + } + else { + item._source.tags = _.filter(item._source.tags, function (tag) { + return tag != "starred"; + }); + } + ElasticSearch.updateTags(item); + }; + + $scope.selectAll = function () { + _.forEach($scope.hits.hits, function (hit) { + hit.__selected = true; + }); + $("#selectAllButton").blur(); + }; + + $scope.deselectAll = function () { + _.forEach($scope.hits.hits, function (hit) { + hit.__selected = false; + }); + $("#deselectAllButton").blur(); + }; + + $scope.toggleOpenItem = function (item) { + + if (item.__open) { + item.__open = false; + } + else { + item.__open = true; + + // If open, do the scroll in a timeout as it has to be done after + // apply. + if (item.__open) { + $timeout(function () { + $(window).scrollTop($("#" + item._id).offset().top - NAV_BAR_HEIGHT); + }, 0); + } + } + }; + + $scope.hitAsJson = function (hit, pretty) { + var filtered = _.pick(hit, function (value, key) { + return key.substring(0, 2) != "__"; + }); + return angular.toJson(filtered, pretty); + } + + $scope.removeHit = function (hit) { + _.remove($scope.hits.hits, hit); + + // Update the currently selected item. + var newIdx = $scope.hits.hits.indexOf($scope.currentSelection); + if (newIdx >= 0) { + $scope.currentSelectionIdx = newIdx; + } + else { + if ($scope.currentSelectionIdx >= $scope.hits.hits.length) { + $scope.currentSelectionIdx = $scope.hits.hits.length - 1; + } + $scope.currentSelection = $scope.hits.hits[$scope.currentSelectionIdx]; + } + }; + + $scope.archiveHit = function (hit) { + ElasticSearch.removeTag(hit, "inbox", + function () { + $scope.removeHit(hit); + if ($scope.hits.hits.length == 0) { + $scope.refresh(); + } + }); + }; + + $scope.archiveSelected = function () { + if ($routeParams.view != "inbox") { + return $scope.displayErrorMessage("Archive not valid in this context."); + } + + var toArchive = _.filter($scope.hits.hits, function (hit) { + return hit.__selected; + }); + if (toArchive.length == 0) { + return $scope.displayErrorMessage("No events selected."); + } + + _.forEach(toArchive, $scope.archiveHit); + + }; + + $scope.deleteHit = function (hit) { + ElasticSearch.delete(hit, + function () { + $scope.removeHit(hit); + + if ($scope.hits.hits.length == 0) { + $scope.refresh(); + } + + }); + }; + + $scope.deleteSelected = function () { + var toDelete = _.filter($scope.hits.hits, function (hit) { + return hit.__selected; + }); + + _.forEach(toDelete, $scope.deleteHit); + }; + + $scope.selectedCount = function () { + try { + return _.filter($scope.hits.hits, function (hit) { + return hit.__selected; + }).length; + } + catch (err) { + return 0; + } + } + + /** Blur/unfocus an item by ID. */ + $scope.blurById = function (id) { + $(id).blur(); + }; + + /** Convert an alert severity into a Bootstrap class for colorization. */ + $scope.severityToBootstrapClass = function (event) { + switch (event._source.alert.severity) { + case 1: + return "danger"; + break; + case 2: + return "warning"; + break; + default: + return "info"; + } + } + + var scrollIdIntoView = function (elementId) { + var element = $("#" + elementId); + if (!isScrolledIntoView(element)) { + $(window).scrollTop(element.position().top - ($(window).height() / 2)); + } + }; + + var toggleCurrentSelection = function () { + $scope.currentSelection.__selected = !$scope.currentSelection.__selected; + }; + + var setActiveAvent = function (event) { + if (_.isNumber(event)) { + $scope.currentSelectionIdx = event; + $scope.currentSelection = $scope.hits.hits[$scope.currentSelectionIdx]; + } + }; + + var moveToNextEntry = function () { + if ($scope.currentSelectionIdx + 1 < $scope.hits.hits.length) { + $scope.currentSelectionIdx += 1; + $scope.currentSelection = $scope.hits.hits[$scope.currentSelectionIdx]; + scrollIdIntoView($scope.currentSelection._id); + } + }; + + var moveToPreviousEntry = function () { + if ($scope.currentSelectionIdx > 0) { + $scope.currentSelectionIdx -= 1; + $scope.currentSelection = $scope.hits.hits[$scope.currentSelectionIdx]; + scrollIdIntoView($scope.currentSelection._id); + } + }; + + $scope.refresh = function () { + + $("#query-input").blur(); + + $scope.state = "loading"; + + ElasticSearch.queryStringSearch($scope.buildQuery(), + {page: $scope.page - 1}).$promise.then( + function (result) { + var data = result; + + $scope.hits = result.hits; + $scope.currentSelection = $scope.hits.hits[0]; + $scope.currentSelectionIdx = 0; + + _.forEach($scope.hits.hits, function (hit) { + hit._source["@timestamp"] = + moment(hit._source["@timestamp"]).format(); + + // Add a tags list if it doesn't exist. + if (hit._source.tags == undefined) { + hit._source.tags = []; + } + + }); + + $(window).scrollTop(0); + }, + function (error) { + if (error.status == 0) { + $scope.displayErrorMessage( + "No response from Elastic Search at " + Config.elasticSearch.url); + } + else { + $scope.displayErrorMessage( + "Error: " + error.status + " " + error.statusText); + } + }).finally(function () { + $scope.state = "ready"; + }); + + }; + + $scope.renderIpAddress = function (addr) { + addr = addr.replace(/0000/g, ""); + while (addr.indexOf(":0:") > -1) { + addr = addr.replace(/:0:/g, "::"); + } + addr = addr.replace(/:::+/g, "::"); + return addr; + }; + + $scope.refresh(); + + /* + * Keyboard bindings. + */ + + $scope.$on("$destroy", function () { + Keyboard.resetScope($scope); + }); + + Keyboard.scopeBind($scope, "r", function (e) { + $scope.refresh(); + }) + + Keyboard.scopeBind($scope, "/", function (e) { + e.preventDefault(); + $("#query-input").focus(); + $("#query-input").select(); + }) + + Keyboard.scopeBind($scope, "j", function (e) { + $scope.$apply(function () { + moveToNextEntry(); + }); + }); + + Keyboard.scopeBind($scope, "shift+j", function (e) { + $scope.$apply(function () { + toggleCurrentSelection(); + moveToNextEntry(); + }); + }) + + Keyboard.scopeBind($scope, "k", function (e) { + $scope.$apply(function () { + moveToPreviousEntry(); + }); + }); + + Keyboard.scopeBind($scope, "shift+k", function (e) { + $scope.$apply(function () { + toggleCurrentSelection(); + moveToPreviousEntry(); + }); + }); + + Keyboard.scopeBind($scope, "x", function (e) { + $scope.currentSelection.__selected = !$scope.currentSelection.__selected; + $scope.$apply(); + }); + + Keyboard.scopeBind($scope, "s", function (e) { + $scope.toggleStar($scope.currentSelection); + $scope.$apply(); + }); + + Keyboard.scopeBind($scope, "* a", function (e) { + $scope.$apply($scope.selectAll()); + }); + + Keyboard.scopeBind($scope, "* n", function (e) { + $scope.$apply($scope.deselectAll()); + }); + + Keyboard.scopeBind($scope, "o", function (e) { + $scope.toggleOpenItem($scope.currentSelection); + $scope.$apply(); + }); + + Keyboard.scopeBind($scope, "e", function (e) { + $scope.$apply($scope.archiveSelected()); + }); + + Keyboard.scopeBind($scope, "#", function (e) { + $scope.deleteSelected(); + }); + + Keyboard.scopeBind($scope, ">", function (e) { + $scope.page++; + $scope.refresh(); + }); + + Keyboard.scopeBind($scope, "<", function (e) { + if ($scope.page > 0) { + $scope.page--; + $scope.refresh(); + } + }); + + Keyboard.scopeBind($scope, "H", function (e) { + $scope.$apply(function () { + $(window).scrollTop(0); + setActiveAvent(0); + }); + }); + + Keyboard.scopeBind($scope, "G", function (e) { + $scope.$apply(function () { + $(window).scrollTop($(document).height()) + setActiveAvent($scope.hits.hits.length - 1); + }); + }); + + Keyboard.scopeBind($scope, ".", function (e) { + $("#dropdown-for-" + $scope.currentSelection._id).dropdown("toggle"); + $("#dropdown-group-for-" + $scope.currentSelection._id + " button").focus(); + }); + +}) +; + +/* + * Non-Angular code - utility functions, etc. + */ + +/** + * Check if an element is currently within the visible area of the window. + * + * From http://stackoverflow.com/questions/487073/check-if-element-is-visible-after-scrolling. + */ +function isScrolledIntoView(elem) { + var docViewTop = $(window).scrollTop() + NAV_BAR_HEIGHT; + var docViewBottom = docViewTop + $(window).height() - NAV_BAR_HEIGHT; + + var elemTop = $(elem).offset().top; + var elemBottom = elemTop + $(elem).height(); + + return ((elemBottom <= docViewBottom) && (elemTop >= docViewTop)); +} + diff --git a/app/scripts/services.js b/app/scripts/services.js new file mode 100644 index 00000000..efd5e836 --- /dev/null +++ b/app/scripts/services.js @@ -0,0 +1,213 @@ +/* + * Copyright (c) 2014 Jason Ish + * All rights reserved. + */ + +/* + * 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 3 of the License, or + * (at your option) any later version. + * + * 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. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +/** + * Centralized configuration. + * + * Merges server provided configuration with local storage configuration. + */ +app.factory("Config", function ($http, $location) { + + var serverConfig = {}; + var localConfig = {}; + + try { + serverConfig = config; + } + catch (error) { + serverConfig = { + elasticSearch: { + url: "http://" + window.location.hostname + ":9200", + size: 100 + } + } + } + + if ("config" in localStorage) { + localConfig = angular.fromJson(localStorage.config); + } + + service = {}; + _.merge(service, serverConfig); + _.merge(service, localConfig); + + service.save = function () { + + if (localConfig.elasticSearch === undefined) { + localConfig.elasticSearch = {}; + } + + if (localConfig.elasticSearch != undefined && service.elasticSearch.url == serverConfig.elasticSearch.url) { + console.log("Deleting current elasticSearch.url"); + delete(localConfig.elasticSearch.url); + } + else { + if (localConfig.elasticSearch === undefined) { + localConfig.elasticSearch = {}; + } + localConfig.elasticSearch.url = service.elasticSearch.url; + } + + if (service.elasticSearch.size == serverConfig.elasticSearch.size) { + delete(localConfig.elasticSearch.size); + } + else { + localConfig.elasticSearch.size = service.elasticSearch.size; + } + + localStorage.config = angular.toJson(localConfig); + + // Force full refresh. + window.location.reload(); + }; + + return service; +}); + +/** + * Elastic Search operations. + */ +app.factory("ElasticSearch", function ($resource, Config) { + + var service = {}; + + service.resource = $resource(Config.elasticSearch.url, null, { + + "update": { + method: "POST", + url: Config.elasticSearch.url + "/:index/:type/:id/_update?refresh=true", + params: { + index: "@index", + type: "@type", + id: "@id" + } + }, + + "search": { + method: "POST", + url: Config.elasticSearch.url + "/_all/_search?refresh=true" + }, + + "delete": { + method: "DELETE", + url: Config.elasticSearch.url + "/:index/:type/:id?refresh=true" + } + + }); + service.update = service.resource.update; + service.search = service.resource.search; + + service.logFailure = function (failure) { + console.log("elastic search server failure: " + failure); + } + + service.delete = function (doc, success, fail) { + if (success == undefined) { + success = function () { + }; + } + if (fail == undefined) { + fail = service.logFailure; + } + return service.resource.delete( + {index: doc._index, type: doc._type, id: doc._id}, success, fail); + }; + + service.updateTags = function (doc) { + return service.resource.update({index: doc._index, type: doc._type, id: doc._id}, + {doc: {tags: doc._source.tags}}); + } + + service.removeTag = function (doc, tag, success, fail) { + return service.resource.update({index: doc._index, type: doc._type, id: doc._id}, + {script: "ctx._source.tags.remove('" + tag + "')"}, success, fail); + } + + service.queryStringSearch = function (queryString, params) { + + var size = Config.elasticSearch.size; + var page = 0 + + if (params.size != undefined) { + size = params.size; + } + if (params.page != undefined) { + page = params.page; + } + + return service.resource.search({ + query: { + filtered: { + query: { + query_string: { + query: queryString + } + } + } + }, + size: size, + from: size * page, + sort: [ + {"@timestamp": {order: "desc"}} + ] + }); + }; + + return service; + +}); + +/** + * A service for keyboard bindings (wrapping Mousetrap) that will track + * the scope a binding was created in for per scope cleanup. + */ +app.factory("Keyboard", function () { + + var service = {}; + service.scopeBindings = {}; + + service.scopeBind = function (scope, key, callback) { + Mousetrap.bind(key, callback); + if (!(scope.$id in service.scopeBindings)) { + service.scopeBindings[scope.$id] = []; + } + service.scopeBindings[scope.$id].push({key: key, callback: callback}); + }; + + service.resetScope = function (scope) { + if (scope.$id in service.scopeBindings) { + _.forEach(service.scopeBindings[scope.$id], function (binding) { + Mousetrap.unbind(binding.key); + }); + service.scopeBindings[scope.$id] = []; + } + + // Something is up with Mousetrap bindings, rebinding existing + // bindings seems to fix it. + for (scopeId in service.scopeBindings) { + _.forEach(service.scopeBindings[scopeId], function (binding) { + Mousetrap.bind(binding.key, binding.callback); + }); + } + }; + + return service; + +}); \ No newline at end of file diff --git a/app/styles/app.css b/app/styles/app.css new file mode 100644 index 00000000..98174db3 --- /dev/null +++ b/app/styles/app.css @@ -0,0 +1,61 @@ +.loading { + opacity: 0.3; +} + +body { + padding-top: 70px; +} + +.navbar-fixed-top { + padding-right: 20px; +} + +.hit-row { + cursor: pointer; + cursor: hand; +} + +.tab-content { + border-left: 1px solid #ddd; + border-right: 1px solid #ddd; + border-bottom: 1px solid #ddd; + padding: 10px; +} + +.nav-tabs { + margin-bottom: 0; +} + +#errorMessage { + position: fixed; + top: 0px; + margin-left: auto; + margin-right: auto; + left: 25%; + right: 25%; + z-index: 2000; + text-align: center; + border-bottom-left-radius: 5px; + border-bottom-right-radius: 5px; +} + +.hit-table { + border: 1px solid #dcdcdc !important; +} + +.hit-table tbody { + border: 1px solid #dcdcdc !important; +} + +.hit-table td { + padding: 0px !important; + padding-left: 3px !important; + padding-right: 3px !important; + margin: 0px !important; + border: 0px !important; +} + +.hit-table pre { + background: inherit; + border: 0px; +} diff --git a/app/views/config.html b/app/views/config.html new file mode 100644 index 00000000..02aad521 --- /dev/null +++ b/app/views/config.html @@ -0,0 +1,22 @@ +
+

Settings

+
+
+
+
+ + +
+ +
+ + +
+
+
+
+ + +
diff --git a/app/views/detail.html b/app/views/detail.html new file mode 100644 index 00000000..dcde63ad --- /dev/null +++ b/app/views/detail.html @@ -0,0 +1,30 @@ +
+
+
+
+ + + + + Send to Dumpy + +
+
+
+
+
+
+ 
{{ hitAsJson(hit, true) }}
+
+
\ No newline at end of file diff --git a/app/views/help.html b/app/views/help.html new file mode 100644 index 00000000..039a2ca4 --- /dev/null +++ b/app/views/help.html @@ -0,0 +1,117 @@ +
+ +
+ +

Help

+
+
+

Keyboard Shortcuts

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
?Help
g then iGo to Inbox
g then sGo to Starred
g then aGo to All
g then cGo to Config
rRefresh
/Search
jNext Item
pPrevious Item
xSelect Item
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
shift+jSelect Item and Move to Next
shift+kSelect Item and Move to Previous
eArchive Selected Items
#Delete Selected Items
sStart Item
oOpen Item
* then aSelect All Items
* then nDeselect All Items
>Previous Page
<Next Page
GGo to Last Event on Page
HGo to First Event on Page
+
+
+ +
+ +
+ +
+ +
\ No newline at end of file diff --git a/app/views/main.html b/app/views/main.html new file mode 100644 index 00000000..f26e27b0 --- /dev/null +++ b/app/views/main.html @@ -0,0 +1,126 @@ +
+ {{ errorMessage }} +
+ +
+ +
+
+ + + + +
+
+ +
+ +
+
+
+ + + + +
+
+
+
+ Loading... +
+
+
+ + +
+
+
+ No results. +
+
+
+ +
+ +
+ +
+ + + + + + + + + + + + + + + + +
+ + + + + + + {{hit._source["@timestamp"]}} + + {{hit._source.alert.signature}} + {{hit._source.proto}} + {{renderIpAddress(hit._source.src_ip)}} + + {{renderIpAddress(hit._source.dest_ip)}} +
+
+
+
+
+ + +
\ No newline at end of file diff --git a/bower.json b/bower.json new file mode 100644 index 00000000..9f963e43 --- /dev/null +++ b/bower.json @@ -0,0 +1,22 @@ +{ + "name": "evebox", + "version": "0.1.0", + "dependencies": { + "angular": "1.2.16", + "json3": "~3.2.6", + "es5-shim": "~2.1.0", + "jquery": "~1.11.0", + "bootstrap": "~3.1.1", + "angular-route": "1.2.16", + "mousetrap": "~1.4.6", + "moment": "~2.6.0", + "angular-resource": "~1.2.16", + "lodash": "~2.4.1", + "angular-bootstrap": "~0.11.0", + "jquery-cookie": "~1.4.1" + }, + "devDependencies": { + "angular-mocks": "1.2.16", + "angular-scenario": "1.2.16" + } +} diff --git a/karma.conf.js b/karma.conf.js new file mode 100644 index 00000000..b3ceda3d --- /dev/null +++ b/karma.conf.js @@ -0,0 +1,55 @@ +// Karma configuration +// http://karma-runner.github.io/0.10/config/configuration-file.html + +module.exports = function (config) { + config.set({ + // base path, that will be used to resolve files and exclude + basePath: '', + + // testing framework to use (jasmine/mocha/qunit/...) + frameworks: ['jasmine'], + + // list of files / patterns to load in the browser + files: [ + 'app/bower_components/jquery/dist/jquery.js', + 'app/bower_components/mousetrap/mousetrap.js', + 'app/bower_components/angular/angular.js', + 'app/bower_components/angular-mocks/angular-mocks.js', + 'app/bower_components/angular-resource/angular-resource.js', + 'app/bower_components/angular-cookies/angular-cookies.js', + 'app/bower_components/angular-route/angular-route.js', + 'app/bower_components/angular-bootstrap/ui-bootstrap-tpls.js', + 'app/scripts/*.js', + 'app/scripts/**/*.js', + 'test/spec/**/*.js' + ], + + // list of files / patterns to exclude + exclude: [], + + // web server port + port: 8080, + + // level of logging + // possible values: LOG_DISABLE || LOG_ERROR || LOG_WARN || LOG_INFO || LOG_DEBUG + //logLevel: config.LOG_DEBUG, + logLevel: config.LOG_INFO, + + // enable / disable watching file and executing tests whenever any file changes + autoWatch: false, + + // Start these browsers, currently available: + // - Chrome + // - ChromeCanary + // - Firefox + // - Opera + // - Safari (only Mac) + // - PhantomJS + // - IE (only Windows) + browsers: ['PhantomJS'], + + // Continuous Integration mode + // if true, it capture browsers, run tests and exit + singleRun: false + }); +}; diff --git a/package.json b/package.json new file mode 100644 index 00000000..12aebebe --- /dev/null +++ b/package.json @@ -0,0 +1,36 @@ +{ + "name": "evebox", + "version": "0.1.0", + "dependencies": {}, + "devDependencies": { + "grunt": "^0.4.4", + "grunt-autoprefixer": "~0.4.0", + "grunt-bower-install": "~1.0.0", + "grunt-concurrent": "~0.5.0", + "grunt-contrib-clean": "~0.5.0", + "grunt-contrib-compress": "^0.9.1", + "grunt-contrib-concat": "~0.3.0", + "grunt-contrib-connect": "~0.5.0", + "grunt-contrib-copy": "~0.4.1", + "grunt-contrib-cssmin": "~0.7.0", + "grunt-contrib-htmlmin": "~0.1.3", + "grunt-contrib-imagemin": "~0.3.0", + "grunt-contrib-jshint": "~0.7.1", + "grunt-contrib-uglify": "~0.2.0", + "grunt-contrib-watch": "~0.5.2", + "grunt-jasmine-node": "^0.2.1", + "grunt-karma": "^0.8.3", + "grunt-newer": "~0.6.1", + "grunt-ngmin": "~0.0.2", + "grunt-rev": "~0.1.0", + "grunt-svgmin": "~0.2.0", + "grunt-usemin": "~2.0.0", + "jshint-stylish": "~0.1.3", + "karma-jasmine": "^0.1.5", + "load-grunt-tasks": "~0.4.0", + "time-grunt": "~0.2.1" + }, + "engines": { + "node": ">=0.10.0" + } +} diff --git a/test/spec/app-tests.js b/test/spec/app-tests.js new file mode 100644 index 00000000..a22365ec --- /dev/null +++ b/test/spec/app-tests.js @@ -0,0 +1,23 @@ +/* A sample test... */ + +'use strict'; + +describe('Controller: MainController', function () { + + var scope; + var controller; + + beforeEach(module('app')); + beforeEach(module('ui.bootstrap')); // Add this line + + beforeEach(inject(function ($rootScope, $controller) { + scope = $rootScope.$new(); + controller = $controller; + })); + + it("should assign message to hello world", function () { + controller("MainController", {$scope: scope}); + expect(scope.page).toBe(1); + }); + +});