├── .travis.yml ├── Dockerfile ├── LICENSE ├── README.md ├── env └── clamd.sh ├── pom.xml ├── src ├── main │ └── java │ │ └── fi │ │ └── solita │ │ └── clamav │ │ ├── ClamAVClient.java │ │ └── ClamAVSizeLimitException.java └── test │ └── java │ └── fi │ └── solita │ └── clamav │ ├── InstreamTest.java │ ├── PingTest.java │ └── SlowInputStream.java └── vagrant └── Vagrantfile /.travis.yml: -------------------------------------------------------------------------------- 1 | sudo: required 2 | 3 | language: java 4 | 5 | services: 6 | - docker 7 | 8 | before_install: 9 | - docker pull lokori/clamav-java 10 | - docker run -d -p 3310:3310 lokori/clamav-java 11 | 12 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM mkodockx/docker-clamav 2 | 3 | MAINTAINER Antti Virtanen 4 | 5 | # update maximum stream length to much smaller than default 6 | # automated tests run smoother this way 7 | RUN sed -i 's/^StreamMaxLength .*$/StreamMaxLength 50100/g' /etc/clamav/clamd.conf 8 | 9 | # av daemon bootstrapping 10 | CMD ["/bootstrap.sh"] 11 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU LESSER GENERAL PUBLIC LICENSE 2 | Version 2.1, February 1999 3 | 4 | Copyright (C) 1991, 1999 Free Software Foundation, Inc. 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | [This is the first released version of the Lesser GPL. It also counts 10 | as the successor of the GNU Library Public License, version 2, hence 11 | the version number 2.1.] 12 | 13 | Preamble 14 | 15 | The licenses for most software are designed to take away your 16 | freedom to share and change it. By contrast, the GNU General Public 17 | Licenses are intended to guarantee your freedom to share and change 18 | free software--to make sure the software is free for all its users. 19 | 20 | This license, the Lesser General Public License, applies to some 21 | specially designated software packages--typically libraries--of the 22 | Free Software Foundation and other authors who decide to use it. You 23 | can use it too, but we suggest you first think carefully about whether 24 | this license or the ordinary General Public License is the better 25 | strategy to use in any particular case, based on the explanations below. 26 | 27 | When we speak of free software, we are referring to freedom of use, 28 | not price. Our General Public Licenses are designed to make sure that 29 | you have the freedom to distribute copies of free software (and charge 30 | for this service if you wish); that you receive source code or can get 31 | it if you want it; that you can change the software and use pieces of 32 | it in new free programs; and that you are informed that you can do 33 | these things. 34 | 35 | To protect your rights, we need to make restrictions that forbid 36 | distributors to deny you these rights or to ask you to surrender these 37 | rights. These restrictions translate to certain responsibilities for 38 | you if you distribute copies of the library or if you modify it. 39 | 40 | For example, if you distribute copies of the library, whether gratis 41 | or for a fee, you must give the recipients all the rights that we gave 42 | you. You must make sure that they, too, receive or can get the source 43 | code. If you link other code with the library, you must provide 44 | complete object files to the recipients, so that they can relink them 45 | with the library after making changes to the library and recompiling 46 | it. And you must show them these terms so they know their rights. 47 | 48 | We protect your rights with a two-step method: (1) we copyright the 49 | library, and (2) we offer you this license, which gives you legal 50 | permission to copy, distribute and/or modify the library. 51 | 52 | To protect each distributor, we want to make it very clear that 53 | there is no warranty for the free library. Also, if the library is 54 | modified by someone else and passed on, the recipients should know 55 | that what they have is not the original version, so that the original 56 | author's reputation will not be affected by problems that might be 57 | introduced by others. 58 | 59 | Finally, software patents pose a constant threat to the existence of 60 | any free program. We wish to make sure that a company cannot 61 | effectively restrict the users of a free program by obtaining a 62 | restrictive license from a patent holder. Therefore, we insist that 63 | any patent license obtained for a version of the library must be 64 | consistent with the full freedom of use specified in this license. 65 | 66 | Most GNU software, including some libraries, is covered by the 67 | ordinary GNU General Public License. This license, the GNU Lesser 68 | General Public License, applies to certain designated libraries, and 69 | is quite different from the ordinary General Public License. We use 70 | this license for certain libraries in order to permit linking those 71 | libraries into non-free programs. 72 | 73 | When a program is linked with a library, whether statically or using 74 | a shared library, the combination of the two is legally speaking a 75 | combined work, a derivative of the original library. The ordinary 76 | General Public License therefore permits such linking only if the 77 | entire combination fits its criteria of freedom. The Lesser General 78 | Public License permits more lax criteria for linking other code with 79 | the library. 80 | 81 | We call this license the "Lesser" General Public License because it 82 | does Less to protect the user's freedom than the ordinary General 83 | Public License. It also provides other free software developers Less 84 | of an advantage over competing non-free programs. These disadvantages 85 | are the reason we use the ordinary General Public License for many 86 | libraries. However, the Lesser license provides advantages in certain 87 | special circumstances. 88 | 89 | For example, on rare occasions, there may be a special need to 90 | encourage the widest possible use of a certain library, so that it becomes 91 | a de-facto standard. To achieve this, non-free programs must be 92 | allowed to use the library. A more frequent case is that a free 93 | library does the same job as widely used non-free libraries. In this 94 | case, there is little to gain by limiting the free library to free 95 | software only, so we use the Lesser General Public License. 96 | 97 | In other cases, permission to use a particular library in non-free 98 | programs enables a greater number of people to use a large body of 99 | free software. For example, permission to use the GNU C Library in 100 | non-free programs enables many more people to use the whole GNU 101 | operating system, as well as its variant, the GNU/Linux operating 102 | system. 103 | 104 | Although the Lesser General Public License is Less protective of the 105 | users' freedom, it does ensure that the user of a program that is 106 | linked with the Library has the freedom and the wherewithal to run 107 | that program using a modified version of the Library. 108 | 109 | The precise terms and conditions for copying, distribution and 110 | modification follow. Pay close attention to the difference between a 111 | "work based on the library" and a "work that uses the library". The 112 | former contains code derived from the library, whereas the latter must 113 | be combined with the library in order to run. 114 | 115 | GNU LESSER GENERAL PUBLIC LICENSE 116 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 117 | 118 | 0. This License Agreement applies to any software library or other 119 | program which contains a notice placed by the copyright holder or 120 | other authorized party saying it may be distributed under the terms of 121 | this Lesser General Public License (also called "this License"). 122 | Each licensee is addressed as "you". 123 | 124 | A "library" means a collection of software functions and/or data 125 | prepared so as to be conveniently linked with application programs 126 | (which use some of those functions and data) to form executables. 127 | 128 | The "Library", below, refers to any such software library or work 129 | which has been distributed under these terms. A "work based on the 130 | Library" means either the Library or any derivative work under 131 | copyright law: that is to say, a work containing the Library or a 132 | portion of it, either verbatim or with modifications and/or translated 133 | straightforwardly into another language. (Hereinafter, translation is 134 | included without limitation in the term "modification".) 135 | 136 | "Source code" for a work means the preferred form of the work for 137 | making modifications to it. For a library, complete source code means 138 | all the source code for all modules it contains, plus any associated 139 | interface definition files, plus the scripts used to control compilation 140 | and installation of the library. 141 | 142 | Activities other than copying, distribution and modification are not 143 | covered by this License; they are outside its scope. The act of 144 | running a program using the Library is not restricted, and output from 145 | such a program is covered only if its contents constitute a work based 146 | on the Library (independent of the use of the Library in a tool for 147 | writing it). Whether that is true depends on what the Library does 148 | and what the program that uses the Library does. 149 | 150 | 1. You may copy and distribute verbatim copies of the Library's 151 | complete source code as you receive it, in any medium, provided that 152 | you conspicuously and appropriately publish on each copy an 153 | appropriate copyright notice and disclaimer of warranty; keep intact 154 | all the notices that refer to this License and to the absence of any 155 | warranty; and distribute a copy of this License along with the 156 | Library. 157 | 158 | You may charge a fee for the physical act of transferring a copy, 159 | and you may at your option offer warranty protection in exchange for a 160 | fee. 161 | 162 | 2. You may modify your copy or copies of the Library or any portion 163 | of it, thus forming a work based on the Library, and copy and 164 | distribute such modifications or work under the terms of Section 1 165 | above, provided that you also meet all of these conditions: 166 | 167 | a) The modified work must itself be a software library. 168 | 169 | b) You must cause the files modified to carry prominent notices 170 | stating that you changed the files and the date of any change. 171 | 172 | c) You must cause the whole of the work to be licensed at no 173 | charge to all third parties under the terms of this License. 174 | 175 | d) If a facility in the modified Library refers to a function or a 176 | table of data to be supplied by an application program that uses 177 | the facility, other than as an argument passed when the facility 178 | is invoked, then you must make a good faith effort to ensure that, 179 | in the event an application does not supply such function or 180 | table, the facility still operates, and performs whatever part of 181 | its purpose remains meaningful. 182 | 183 | (For example, a function in a library to compute square roots has 184 | a purpose that is entirely well-defined independent of the 185 | application. Therefore, Subsection 2d requires that any 186 | application-supplied function or table used by this function must 187 | be optional: if the application does not supply it, the square 188 | root function must still compute square roots.) 189 | 190 | These requirements apply to the modified work as a whole. If 191 | identifiable sections of that work are not derived from the Library, 192 | and can be reasonably considered independent and separate works in 193 | themselves, then this License, and its terms, do not apply to those 194 | sections when you distribute them as separate works. But when you 195 | distribute the same sections as part of a whole which is a work based 196 | on the Library, the distribution of the whole must be on the terms of 197 | this License, whose permissions for other licensees extend to the 198 | entire whole, and thus to each and every part regardless of who wrote 199 | it. 200 | 201 | Thus, it is not the intent of this section to claim rights or contest 202 | your rights to work written entirely by you; rather, the intent is to 203 | exercise the right to control the distribution of derivative or 204 | collective works based on the Library. 205 | 206 | In addition, mere aggregation of another work not based on the Library 207 | with the Library (or with a work based on the Library) on a volume of 208 | a storage or distribution medium does not bring the other work under 209 | the scope of this License. 210 | 211 | 3. You may opt to apply the terms of the ordinary GNU General Public 212 | License instead of this License to a given copy of the Library. To do 213 | this, you must alter all the notices that refer to this License, so 214 | that they refer to the ordinary GNU General Public License, version 2, 215 | instead of to this License. (If a newer version than version 2 of the 216 | ordinary GNU General Public License has appeared, then you can specify 217 | that version instead if you wish.) Do not make any other change in 218 | these notices. 219 | 220 | Once this change is made in a given copy, it is irreversible for 221 | that copy, so the ordinary GNU General Public License applies to all 222 | subsequent copies and derivative works made from that copy. 223 | 224 | This option is useful when you wish to copy part of the code of 225 | the Library into a program that is not a library. 226 | 227 | 4. You may copy and distribute the Library (or a portion or 228 | derivative of it, under Section 2) in object code or executable form 229 | under the terms of Sections 1 and 2 above provided that you accompany 230 | it with the complete corresponding machine-readable source code, which 231 | must be distributed under the terms of Sections 1 and 2 above on a 232 | medium customarily used for software interchange. 233 | 234 | If distribution of object code is made by offering access to copy 235 | from a designated place, then offering equivalent access to copy the 236 | source code from the same place satisfies the requirement to 237 | distribute the source code, even though third parties are not 238 | compelled to copy the source along with the object code. 239 | 240 | 5. A program that contains no derivative of any portion of the 241 | Library, but is designed to work with the Library by being compiled or 242 | linked with it, is called a "work that uses the Library". Such a 243 | work, in isolation, is not a derivative work of the Library, and 244 | therefore falls outside the scope of this License. 245 | 246 | However, linking a "work that uses the Library" with the Library 247 | creates an executable that is a derivative of the Library (because it 248 | contains portions of the Library), rather than a "work that uses the 249 | library". The executable is therefore covered by this License. 250 | Section 6 states terms for distribution of such executables. 251 | 252 | When a "work that uses the Library" uses material from a header file 253 | that is part of the Library, the object code for the work may be a 254 | derivative work of the Library even though the source code is not. 255 | Whether this is true is especially significant if the work can be 256 | linked without the Library, or if the work is itself a library. The 257 | threshold for this to be true is not precisely defined by law. 258 | 259 | If such an object file uses only numerical parameters, data 260 | structure layouts and accessors, and small macros and small inline 261 | functions (ten lines or less in length), then the use of the object 262 | file is unrestricted, regardless of whether it is legally a derivative 263 | work. (Executables containing this object code plus portions of the 264 | Library will still fall under Section 6.) 265 | 266 | Otherwise, if the work is a derivative of the Library, you may 267 | distribute the object code for the work under the terms of Section 6. 268 | Any executables containing that work also fall under Section 6, 269 | whether or not they are linked directly with the Library itself. 270 | 271 | 6. As an exception to the Sections above, you may also combine or 272 | link a "work that uses the Library" with the Library to produce a 273 | work containing portions of the Library, and distribute that work 274 | under terms of your choice, provided that the terms permit 275 | modification of the work for the customer's own use and reverse 276 | engineering for debugging such modifications. 277 | 278 | You must give prominent notice with each copy of the work that the 279 | Library is used in it and that the Library and its use are covered by 280 | this License. You must supply a copy of this License. If the work 281 | during execution displays copyright notices, you must include the 282 | copyright notice for the Library among them, as well as a reference 283 | directing the user to the copy of this License. Also, you must do one 284 | of these things: 285 | 286 | a) Accompany the work with the complete corresponding 287 | machine-readable source code for the Library including whatever 288 | changes were used in the work (which must be distributed under 289 | Sections 1 and 2 above); and, if the work is an executable linked 290 | with the Library, with the complete machine-readable "work that 291 | uses the Library", as object code and/or source code, so that the 292 | user can modify the Library and then relink to produce a modified 293 | executable containing the modified Library. (It is understood 294 | that the user who changes the contents of definitions files in the 295 | Library will not necessarily be able to recompile the application 296 | to use the modified definitions.) 297 | 298 | b) Use a suitable shared library mechanism for linking with the 299 | Library. A suitable mechanism is one that (1) uses at run time a 300 | copy of the library already present on the user's computer system, 301 | rather than copying library functions into the executable, and (2) 302 | will operate properly with a modified version of the library, if 303 | the user installs one, as long as the modified version is 304 | interface-compatible with the version that the work was made with. 305 | 306 | c) Accompany the work with a written offer, valid for at 307 | least three years, to give the same user the materials 308 | specified in Subsection 6a, above, for a charge no more 309 | than the cost of performing this distribution. 310 | 311 | d) If distribution of the work is made by offering access to copy 312 | from a designated place, offer equivalent access to copy the above 313 | specified materials from the same place. 314 | 315 | e) Verify that the user has already received a copy of these 316 | materials or that you have already sent this user a copy. 317 | 318 | For an executable, the required form of the "work that uses the 319 | Library" must include any data and utility programs needed for 320 | reproducing the executable from it. However, as a special exception, 321 | the materials to be distributed need not include anything that is 322 | normally distributed (in either source or binary form) with the major 323 | components (compiler, kernel, and so on) of the operating system on 324 | which the executable runs, unless that component itself accompanies 325 | the executable. 326 | 327 | It may happen that this requirement contradicts the license 328 | restrictions of other proprietary libraries that do not normally 329 | accompany the operating system. Such a contradiction means you cannot 330 | use both them and the Library together in an executable that you 331 | distribute. 332 | 333 | 7. You may place library facilities that are a work based on the 334 | Library side-by-side in a single library together with other library 335 | facilities not covered by this License, and distribute such a combined 336 | library, provided that the separate distribution of the work based on 337 | the Library and of the other library facilities is otherwise 338 | permitted, and provided that you do these two things: 339 | 340 | a) Accompany the combined library with a copy of the same work 341 | based on the Library, uncombined with any other library 342 | facilities. This must be distributed under the terms of the 343 | Sections above. 344 | 345 | b) Give prominent notice with the combined library of the fact 346 | that part of it is a work based on the Library, and explaining 347 | where to find the accompanying uncombined form of the same work. 348 | 349 | 8. You may not copy, modify, sublicense, link with, or distribute 350 | the Library except as expressly provided under this License. Any 351 | attempt otherwise to copy, modify, sublicense, link with, or 352 | distribute the Library is void, and will automatically terminate your 353 | rights under this License. However, parties who have received copies, 354 | or rights, from you under this License will not have their licenses 355 | terminated so long as such parties remain in full compliance. 356 | 357 | 9. You are not required to accept this License, since you have not 358 | signed it. However, nothing else grants you permission to modify or 359 | distribute the Library or its derivative works. These actions are 360 | prohibited by law if you do not accept this License. Therefore, by 361 | modifying or distributing the Library (or any work based on the 362 | Library), you indicate your acceptance of this License to do so, and 363 | all its terms and conditions for copying, distributing or modifying 364 | the Library or works based on it. 365 | 366 | 10. Each time you redistribute the Library (or any work based on the 367 | Library), the recipient automatically receives a license from the 368 | original licensor to copy, distribute, link with or modify the Library 369 | subject to these terms and conditions. You may not impose any further 370 | restrictions on the recipients' exercise of the rights granted herein. 371 | You are not responsible for enforcing compliance by third parties with 372 | this License. 373 | 374 | 11. If, as a consequence of a court judgment or allegation of patent 375 | infringement or for any other reason (not limited to patent issues), 376 | conditions are imposed on you (whether by court order, agreement or 377 | otherwise) that contradict the conditions of this License, they do not 378 | excuse you from the conditions of this License. If you cannot 379 | distribute so as to satisfy simultaneously your obligations under this 380 | License and any other pertinent obligations, then as a consequence you 381 | may not distribute the Library at all. For example, if a patent 382 | license would not permit royalty-free redistribution of the Library by 383 | all those who receive copies directly or indirectly through you, then 384 | the only way you could satisfy both it and this License would be to 385 | refrain entirely from distribution of the Library. 386 | 387 | If any portion of this section is held invalid or unenforceable under any 388 | particular circumstance, the balance of the section is intended to apply, 389 | and the section as a whole is intended to apply in other circumstances. 390 | 391 | It is not the purpose of this section to induce you to infringe any 392 | patents or other property right claims or to contest validity of any 393 | such claims; this section has the sole purpose of protecting the 394 | integrity of the free software distribution system which is 395 | implemented by public license practices. Many people have made 396 | generous contributions to the wide range of software distributed 397 | through that system in reliance on consistent application of that 398 | system; it is up to the author/donor to decide if he or she is willing 399 | to distribute software through any other system and a licensee cannot 400 | impose that choice. 401 | 402 | This section is intended to make thoroughly clear what is believed to 403 | be a consequence of the rest of this License. 404 | 405 | 12. If the distribution and/or use of the Library is restricted in 406 | certain countries either by patents or by copyrighted interfaces, the 407 | original copyright holder who places the Library under this License may add 408 | an explicit geographical distribution limitation excluding those countries, 409 | so that distribution is permitted only in or among countries not thus 410 | excluded. In such case, this License incorporates the limitation as if 411 | written in the body of this License. 412 | 413 | 13. The Free Software Foundation may publish revised and/or new 414 | versions of the Lesser General Public License from time to time. 415 | Such new versions will be similar in spirit to the present version, 416 | but may differ in detail to address new problems or concerns. 417 | 418 | Each version is given a distinguishing version number. If the Library 419 | specifies a version number of this License which applies to it and 420 | "any later version", you have the option of following the terms and 421 | conditions either of that version or of any later version published by 422 | the Free Software Foundation. If the Library does not specify a 423 | license version number, you may choose any version ever published by 424 | the Free Software Foundation. 425 | 426 | 14. If you wish to incorporate parts of the Library into other free 427 | programs whose distribution conditions are incompatible with these, 428 | write to the author to ask for permission. For software which is 429 | copyrighted by the Free Software Foundation, write to the Free 430 | Software Foundation; we sometimes make exceptions for this. Our 431 | decision will be guided by the two goals of preserving the free status 432 | of all derivatives of our free software and of promoting the sharing 433 | and reuse of software generally. 434 | 435 | NO WARRANTY 436 | 437 | 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO 438 | WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. 439 | EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR 440 | OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY 441 | KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE 442 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 443 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE 444 | LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME 445 | THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 446 | 447 | 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN 448 | WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY 449 | AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU 450 | FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR 451 | CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE 452 | LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING 453 | RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A 454 | FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF 455 | SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH 456 | DAMAGES. 457 | 458 | END OF TERMS AND CONDITIONS 459 | 460 | How to Apply These Terms to Your New Libraries 461 | 462 | If you develop a new library, and you want it to be of the greatest 463 | possible use to the public, we recommend making it free software that 464 | everyone can redistribute and change. You can do so by permitting 465 | redistribution under these terms (or, alternatively, under the terms of the 466 | ordinary General Public License). 467 | 468 | To apply these terms, attach the following notices to the library. It is 469 | safest to attach them to the start of each source file to most effectively 470 | convey the exclusion of warranty; and each file should have at least the 471 | "copyright" line and a pointer to where the full notice is found. 472 | 473 | 474 | Copyright (C) 475 | 476 | This library is free software; you can redistribute it and/or 477 | modify it under the terms of the GNU Lesser General Public 478 | License as published by the Free Software Foundation; either 479 | version 2.1 of the License, or (at your option) any later version. 480 | 481 | This library is distributed in the hope that it will be useful, 482 | but WITHOUT ANY WARRANTY; without even the implied warranty of 483 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 484 | Lesser General Public License for more details. 485 | 486 | You should have received a copy of the GNU Lesser General Public 487 | License along with this library; if not, write to the Free Software 488 | Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 489 | 490 | Also add information on how to contact you by electronic and paper mail. 491 | 492 | You should also get your employer (if you work as a programmer) or your 493 | school, if any, to sign a "copyright disclaimer" for the library, if 494 | necessary. Here is a sample; alter the names: 495 | 496 | Yoyodyne, Inc., hereby disclaims all copyright interest in the 497 | library `Frob' (a library for tweaking knobs) written by James Random Hacker. 498 | 499 | , 1 April 1990 500 | Ty Coon, President of Vice 501 | 502 | That's all there is to it! 503 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Simple [ClamAV](http://www.clamav.net/) Java client. See also [ClamAV REST service](https://github.com/solita/clamav-rest) which builds on top of this. 2 | 3 | Travis CI: [![Build Status](https://travis-ci.org/solita/clamav-java.svg?branch=master)](https://travis-ci.org/solita/clamav-java) 4 | 5 | # What is provided 6 | 7 | Support for basic INSTREAM scanning and PING command. 8 | 9 | Clamd protocol is explained here: 10 | http://linux.die.net/man/8/clamd 11 | 12 | A REST style API and server can be found from another repository, [clamav-rest](https://github.com/solita/clamav-rest). 13 | 14 | # Using the client 15 | 16 | Code is self explanatory. Something like this is the idea: 17 | 18 | ``` 19 | ClamAVClient cl = new ClamAVClient("192.168.50.72", 3310); 20 | byte[] reply; 21 | try { 22 | reply = cl.scan(input); 23 | } catch (Exception e) { 24 | throw new RuntimeException("Could not scan the input", e); 25 | } 26 | if (!ClamAVClient.isCleanReply(reply)) { 27 | throw new Exception("aaargh. Something was found"); 28 | } 29 | ``` 30 | 31 | # Maven dependency 32 | 33 | ``` 34 | 35 | fi.solita.clamav 36 | clamav-client 37 | 1.0.1 38 | 39 | ``` 40 | 41 | # Creating the jar 42 | 43 | ``` 44 | mvn install 45 | ``` 46 | 47 | # Testing the client 48 | 49 | To run the automated tests you are assumed to run the clamd in a local virtual machine. 50 | Configuration for [Vagrant](http://www.vagrantup.com/) and [Oracle Virtualbox](https://www.virtualbox.org/) is provided. 51 | 52 | To start test server simply 53 | 54 | ``` 55 | cd vagrant 56 | vagrant up clamav 57 | ``` 58 | 59 | This will kick up a CentOS virtual machine and install [ClamAV](http://www.clamav.net/) in it. 60 | 61 | Alternatively, you could use Docker image to run ClamAV. Automated tests with Travis CI run using [Docker image for ClamAV](https://hub.docker.com/r/lokori/clamav-java/). The test image runs with artificially low MaxStreamLength setting on purpose. 62 | 63 | ## Contributors 64 | 65 | * [Antti Virtanen](https://github.com/lokori) 66 | * [Ari Ruotsalainen](https://github.com/ruoat) 67 | * [Heikki Hokkanen](https://github.com/hoxu) 68 | * [Henrik Alstad](https://github.com/drogin) 69 | 70 | 71 | # License 72 | 73 | Copyright © 2014 [Solita](http://www.solita.fi) 74 | 75 | Distributed under the GNU Lesser General Public License, either version 2.1 of the License, or 76 | (at your option) any later version. 77 | 78 | -------------------------------------------------------------------------------- /env/clamd.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | set -eu 3 | 4 | # EPEL 5 | rpm -Uvh http://dl.fedoraproject.org/pub/epel/6/x86_64/epel-release-6-8.noarch.rpm 6 | 7 | # ClamAV 8 | yum install -y clamav clamd 9 | 10 | # take off firewall (local virtual machine - ok) 11 | iptables -F 12 | 13 | # listen to our local IP, not only on localhost 14 | echo 'TCPAddr 192.168.50.72' >> /etc/clamd.conf 15 | 16 | service clamd restart 17 | 18 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 5 | 6 | 4.0.0 7 | 8 | 9 | org.sonatype.oss 10 | oss-parent 11 | 7 12 | 13 | 14 | fi.solita.clamav 15 | clamav-client 16 | 1.0.1 17 | jar 18 | Simple ClamAV client 19 | Simple Java client for using clamd INSTREAM scanning in your application. 20 | https://github.com/solita/clamav-java 21 | 22 | 23 | GNU LESSER GENERAL PUBLIC LICENSE, Version 2.1 24 | http://www.gnu.org/licenses/lgpl.txt 25 | 26 | 27 | 28 | 29 | Antti Virtanen 30 | antti.virtanen@solita.fi 31 | Solita 32 | http://www.solita.fi 33 | 34 | 35 | 36 | 37 | UTF-8 38 | 39 | 40 | 41 | scm:git:git://github.com/solita/clamav-java.git 42 | scm:git:git@github.com:solita/clamav-java.git 43 | https://github.com/solita/clamav-java 44 | 45 | 46 | 47 | 48 | junit 49 | junit 50 | 4.11 51 | test 52 | 53 | 54 | 55 | 56 | 57 | 58 | maven-compiler-plugin 59 | 2.3.2 60 | 61 | 1.7 62 | 1.7 63 | 64 | 65 | 66 | 67 | org.sonatype.plugins 68 | nexus-staging-maven-plugin 69 | 1.6.3 70 | true 71 | 72 | https://oss.sonatype.org/ 73 | ossrh-releases-fi.solita 74 | ff5044adfb72 75 | 76 | 77 | 78 | 79 | 80 | 81 | -------------------------------------------------------------------------------- /src/main/java/fi/solita/clamav/ClamAVClient.java: -------------------------------------------------------------------------------- 1 | package fi.solita.clamav; 2 | 3 | import java.io.BufferedOutputStream; 4 | import java.io.ByteArrayInputStream; 5 | import java.io.ByteArrayOutputStream; 6 | import java.io.IOException; 7 | import java.io.InputStream; 8 | import java.io.OutputStream; 9 | import java.net.Socket; 10 | import java.net.SocketException; 11 | import java.nio.ByteBuffer; 12 | import java.nio.charset.StandardCharsets; 13 | import java.util.Arrays; 14 | 15 | /** 16 | * Simple client for ClamAV's clamd scanner. Provides straightforward instream scanning. 17 | */ 18 | public class ClamAVClient { 19 | 20 | private String hostName; 21 | private int port; 22 | private int timeout; 23 | 24 | // "do not exceed StreamMaxLength as defined in clamd.conf, otherwise clamd will reply with INSTREAM size limit exceeded and close the connection." 25 | private static final int CHUNK_SIZE = 2048; 26 | private static final int DEFAULT_TIMEOUT = 500; 27 | private static final int PONG_REPLY_LEN = 4; 28 | 29 | /** 30 | * @param hostName The hostname of the server running clamav-daemon 31 | * @param port The port that clamav-daemon listens to(By default it might not listen to a port. Check your clamav configuration). 32 | * @param timeout zero means infinite timeout. Not a good idea, but will be accepted. 33 | */ 34 | public ClamAVClient(String hostName, int port, int timeout) { 35 | if (timeout < 0) { 36 | throw new IllegalArgumentException("Negative timeout value does not make sense."); 37 | } 38 | this.hostName = hostName; 39 | this.port = port; 40 | this.timeout = timeout; 41 | } 42 | 43 | public ClamAVClient(String hostName, int port) { 44 | this(hostName, port, DEFAULT_TIMEOUT); 45 | } 46 | 47 | /** 48 | * Run PING command to clamd to test it is responding. 49 | * 50 | * @return true if the server responded with proper ping reply. 51 | */ 52 | public boolean ping() throws IOException { 53 | try (Socket s = new Socket(hostName,port); OutputStream outs = s.getOutputStream()) { 54 | s.setSoTimeout(timeout); 55 | outs.write(asBytes("zPING\0")); 56 | outs.flush(); 57 | byte[] b = new byte[PONG_REPLY_LEN]; 58 | InputStream inputStream = s.getInputStream(); 59 | int copyIndex = 0; 60 | int readResult; 61 | do { 62 | readResult = inputStream.read(b, copyIndex, Math.max(b.length - copyIndex, 0)); 63 | copyIndex += readResult; 64 | } while (readResult > 0); 65 | return Arrays.equals(b, asBytes("PONG")); 66 | } 67 | } 68 | 69 | /** 70 | * Streams the given data to the server in chunks. The whole data is not kept in memory. 71 | * This method is preferred if you don't want to keep the data in memory, for instance by scanning a file on disk. 72 | * Since the parameter InputStream is not reset, you can not use the stream afterwards, as it will be left in a EOF-state. 73 | * If your goal is to scan some data, and then pass that data further, consider using {@link #scan(byte[]) scan(byte[] in)}. 74 | *

75 | * Opens a socket and reads the reply. Parameter input stream is NOT closed. 76 | * 77 | * @param is data to scan. Not closed by this method! 78 | * @return server reply 79 | */ 80 | public byte[] scan(InputStream is) throws IOException { 81 | try (Socket s = new Socket(hostName,port); OutputStream outs = new BufferedOutputStream(s.getOutputStream())) { 82 | s.setSoTimeout(timeout); 83 | 84 | // handshake 85 | outs.write(asBytes("zINSTREAM\0")); 86 | outs.flush(); 87 | byte[] chunk = new byte[CHUNK_SIZE]; 88 | 89 | try (InputStream clamIs = s.getInputStream()) { 90 | // send data 91 | int read = is.read(chunk); 92 | while (read >= 0) { 93 | // The format of the chunk is: '' where is the size of the following data in bytes expressed as a 4 byte unsigned 94 | // integer in network byte order and is the actual chunk. Streaming is terminated by sending a zero-length chunk. 95 | byte[] chunkSize = ByteBuffer.allocate(4).putInt(read).array(); 96 | 97 | outs.write(chunkSize); 98 | outs.write(chunk, 0, read); 99 | if (clamIs.available() > 0) { 100 | // reply from server before scan command has been terminated. 101 | byte[] reply = assertSizeLimit(readAll(clamIs)); 102 | throw new IOException("Scan aborted. Reply from server: " + new String(reply, StandardCharsets.US_ASCII)); 103 | } 104 | read = is.read(chunk); 105 | } 106 | 107 | // terminate scan 108 | outs.write(new byte[]{0,0,0,0}); 109 | outs.flush(); 110 | // read reply 111 | return assertSizeLimit(readAll(clamIs)); 112 | } 113 | } 114 | } 115 | 116 | /** 117 | * Scans bytes for virus by passing the bytes to clamav 118 | * 119 | * @param in data to scan 120 | * @return server reply 121 | **/ 122 | public byte[] scan(byte[] in) throws IOException { 123 | ByteArrayInputStream bis = new ByteArrayInputStream(in); 124 | return scan(bis); 125 | } 126 | 127 | /** 128 | * Interpret the result from a ClamAV scan, and determine if the result means the data is clean 129 | * 130 | * @param reply The reply from the server after scanning 131 | * @return true if no virus was found according to the clamd reply message 132 | */ 133 | public static boolean isCleanReply(byte[] reply) { 134 | String r = new String(reply, StandardCharsets.US_ASCII); 135 | return (r.contains("OK") && !r.contains("FOUND")); 136 | } 137 | 138 | 139 | private byte[] assertSizeLimit(byte[] reply) { 140 | String r = new String(reply, StandardCharsets.US_ASCII); 141 | if (r.startsWith("INSTREAM size limit exceeded.")) 142 | throw new ClamAVSizeLimitException("Clamd size limit exceeded. Full reply from server: " + r); 143 | return reply; 144 | } 145 | 146 | // byte conversion based on ASCII character set regardless of the current system locale 147 | private static byte[] asBytes(String s) { 148 | return s.getBytes(StandardCharsets.US_ASCII); 149 | } 150 | 151 | // reads all available bytes from the stream 152 | private static byte[] readAll(InputStream is) throws IOException { 153 | ByteArrayOutputStream tmp = new ByteArrayOutputStream(); 154 | 155 | byte[] buf = new byte[2000]; 156 | int read = 0; 157 | do { 158 | read = is.read(buf); 159 | tmp.write(buf, 0, read); 160 | } while ((read > 0) && (is.available() > 0)); 161 | return tmp.toByteArray(); 162 | } 163 | } 164 | -------------------------------------------------------------------------------- /src/main/java/fi/solita/clamav/ClamAVSizeLimitException.java: -------------------------------------------------------------------------------- 1 | package fi.solita.clamav; 2 | 3 | /** 4 | * Thrown if clamd size limit is exceeded during scanning. 5 | *

6 | * See clamd man page for further information. 7 | */ 8 | public class ClamAVSizeLimitException extends RuntimeException { 9 | private static final long serialVersionUID = 1L; 10 | 11 | public ClamAVSizeLimitException(String msg) { 12 | super(msg); 13 | } 14 | } 15 | -------------------------------------------------------------------------------- /src/test/java/fi/solita/clamav/InstreamTest.java: -------------------------------------------------------------------------------- 1 | package fi.solita.clamav; 2 | 3 | import static org.junit.Assert.assertFalse; 4 | import static org.junit.Assert.assertTrue; 5 | 6 | import java.io.IOException; 7 | import java.io.InputStream; 8 | import java.net.UnknownHostException; 9 | 10 | import org.junit.Test; 11 | 12 | /** 13 | * These tests assume clamd is running and responding in the virtual machine. 14 | */ 15 | public class InstreamTest { 16 | 17 | private static String CLAMAV_HOST = "localhost"; 18 | 19 | private byte[] scan(byte[] input) throws UnknownHostException, IOException { 20 | ClamAVClient cl = new ClamAVClient(CLAMAV_HOST, 3310); 21 | return cl.scan(input); 22 | } 23 | 24 | private byte[] scan(InputStream input) throws UnknownHostException, IOException { 25 | ClamAVClient cl = new ClamAVClient(CLAMAV_HOST, 3310); 26 | return cl.scan(input); 27 | } 28 | @Test 29 | public void testRandomBytes() throws UnknownHostException, IOException { 30 | byte[] r = scan("alsdklaksdla".getBytes("ASCII")); 31 | assertTrue(ClamAVClient.isCleanReply(r)); 32 | } 33 | 34 | @Test 35 | public void testPositive() throws UnknownHostException, IOException { 36 | // http://www.eicar.org/86-0-Intended-use.html 37 | byte[] EICAR = "X5O!P%@AP[4\\PZX54(P^)7CC)7}$EICAR-STANDARD-ANTIVIRUS-TEST-FILE!$H+H*".getBytes("ASCII"); 38 | byte[] r = scan(EICAR); 39 | assertFalse(ClamAVClient.isCleanReply(r)); 40 | } 41 | 42 | @Test 43 | public void testStreamChunkingWorks() throws UnknownHostException, IOException { 44 | byte[] multipleChunks = new byte[50000]; 45 | byte[] r = scan(multipleChunks); 46 | assertTrue(ClamAVClient.isCleanReply(r)); 47 | } 48 | 49 | @Test 50 | public void testChunkLimit() throws UnknownHostException, IOException { 51 | byte[] maximumChunk = new byte[2048]; 52 | byte[] r = scan(maximumChunk); 53 | assertTrue(ClamAVClient.isCleanReply(r)); 54 | } 55 | 56 | @Test 57 | public void testZeroBytes() throws UnknownHostException, IOException { 58 | byte[] r = scan(new byte[]{}); 59 | assertTrue(ClamAVClient.isCleanReply(r)); 60 | } 61 | 62 | @Test(expected = ClamAVSizeLimitException.class) 63 | public void testSizeLimit() throws UnknownHostException, IOException { 64 | scan(new SlowInputStream()); 65 | } 66 | } 67 | -------------------------------------------------------------------------------- /src/test/java/fi/solita/clamav/PingTest.java: -------------------------------------------------------------------------------- 1 | package fi.solita.clamav; 2 | 3 | import static org.junit.Assert.assertTrue; 4 | 5 | import java.io.IOException; 6 | import java.net.UnknownHostException; 7 | 8 | import org.junit.Test; 9 | 10 | /** 11 | * These tests assume clamd is running and responding in the virtual machine. 12 | */ 13 | public class PingTest { 14 | 15 | @Test 16 | public void testPingPong() throws UnknownHostException, IOException { 17 | ClamAVClient cl = new ClamAVClient("localhost", 3310); 18 | assertTrue(cl.ping()); 19 | } 20 | } 21 | -------------------------------------------------------------------------------- /src/test/java/fi/solita/clamav/SlowInputStream.java: -------------------------------------------------------------------------------- 1 | package fi.solita.clamav; 2 | 3 | import java.io.InputStream; 4 | import java.util.Random; 5 | 6 | /** 7 | * Random bytes generated, until in the end it slows down.. this enables testing the clamd 8 | * stream length limit as clamd has enough time to reply, close the socket or whatever. 9 | */ 10 | public class SlowInputStream extends InputStream { 11 | 12 | private static long SLOW_BYTE = 1000; 13 | private long bytesAvail = 60000; 14 | private Random r = new Random(); 15 | 16 | @Override 17 | public int read() { 18 | int nextByte = r.nextInt(256); 19 | if ((bytesAvail < 12000) && ((bytesAvail % SLOW_BYTE) == 0)) { 20 | try { 21 | Thread.sleep(80); // 80 ms sleep 22 | } catch (Exception e) { 23 | throw new RuntimeException(e); 24 | } 25 | } 26 | bytesAvail--; 27 | return (bytesAvail == 0) ? -1 : nextByte; 28 | } 29 | } 30 | -------------------------------------------------------------------------------- /vagrant/Vagrantfile: -------------------------------------------------------------------------------- 1 | # -*- mode: ruby -*- 2 | # vi: set ft=ruby : 3 | 4 | Vagrant.configure("2") do |config| 5 | 6 | # https://github.com/fgrehm/vagrant-cachier#quick-start 7 | if Vagrant.has_plugin?("vagrant-cachier") 8 | config.cache.scope = :box 9 | config.cache.synced_folder_opts = { 10 | type: :nfs, 11 | mount_options: ['rw', 'vers=3', 'tcp', 'nolock'] 12 | } 13 | end 14 | 15 | vmbox = "CentOS-6.5-x86_64-v20140311.box" 16 | vmbox_url = "http://developer.nrel.gov/downloads/vagrant-boxes/CentOS-6.5-x86_64-v20140311.box" 17 | 18 | 19 | # Test server for ClamAV virus scanner 20 | config.vm.define "clamav" do |clamav| 21 | clamav.vm.box = vmbox 22 | clamav.vm.box_url = vmbox_url 23 | 24 | clamav.vm.synced_folder "../env", "/env" 25 | clamav.vm.provision "shell", inline: "cd /env && ./clamd.sh" 26 | 27 | clamav.vm.network "private_network", ip: "192.168.50.72" 28 | 29 | clamav.vm.network "forwarded_port", host: 3310, guest: 3310 30 | end 31 | end 32 | --------------------------------------------------------------------------------