3 ##############################################################################################
4 # uagen (http://www.fabiankeil.de/sourcecode/uagen/)
6 # $Id: uagen.pl,v 1.7 2010/10/30 15:57:26 fabiankeil Exp $
8 # Generates a pseudo-random Firefox user agent and writes it into a Privoxy action file
9 # and optionally into a Mozilla prefs file. For documentation see 'perldoc uagen(.pl)'.
11 # Examples (created with v1.0):
13 # Mozilla/5.0 (X11; U; NetBSD i386; en-US; rv:1.8.0.2) Gecko/20060421 Firefox/1.5.0.2
14 # Mozilla/5.0 (Macintosh; U; Intel Mac OS X; en-CA; rv:1.8.0.2) Gecko/20060425 Firefox/1.5.0.2
15 # Mozilla/5.0 (X11; U; SunOS i86pc; no-NO; rv:1.8.0.2) Gecko/20060420 Firefox/1.5.0.2
16 # Mozilla/5.0 (X11; U; Linux x86_64; de-AT; rv:1.8.0.2) Gecko/20060422 Firefox/1.5.0.2
17 # Mozilla/5.0 (X11; U; NetBSD i386; en-US; rv:1.8.0.2) Gecko/20060415 Firefox/1.5.0.2
18 # Mozilla/5.0 (X11; U; OpenBSD sparc64; pl-PL; rv:1.8.0.2) Gecko/20060429 Firefox/1.5.0.2
19 # Mozilla/5.0 (X11; U; Linux i686; en-CA; rv:1.8.0.2) Gecko/20060413 Firefox/1.5.0.2
21 # Copyright (c) 2006-2009 Fabian Keil <fk@fabiankeil.de>
23 # Permission to use, copy, modify, and distribute this software for any
24 # purpose with or without fee is hereby granted, provided that the above
25 # copyright notice and this permission notice appear in all copies.
27 # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
28 # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
29 # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
30 # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
31 # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
32 # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
33 # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
34 ##############################################################################################
43 UAGEN_VERSION => 'uagen 1.0.10',
45 UAGEN_LOGFILE => '/var/log/uagen.log',
46 ACTION_FILE => '/etc/privoxy/user-agent.action',
47 MOZILLA_PREFS_FILE => '',
54 # These variables belong together. If you only change one of them, the generated
55 # User-Agent might be invalid. If you're not sure which values make sense,
56 # are too lazy to check, but want to change them anyway, take the values you
57 # see in the "Help/About Mozilla Firefox" menu.
59 BROWSER_VERSION => "3.6.12",
60 BROWSER_REVISION => '1.9.2.12',
61 BROWSER_RELEASE_DATE => '20101028',
64 use constant LANGUAGES => qw(
65 en-AU en-GB en-CA en-NZ en-US en-ZW es-ES de-DE de-AT de-CH fr-FR sk-SK nl-NL no-NO pl-PL
68 #######################################################################################
70 sub generate_creation_time($) {
71 my $release_date = $_ = shift;
73 my ($rel_year, $rel_mon, $rel_day);
74 my ($c_day, $c_mon, $c_year);
76 my ( $sec, $min, $hour, $mday, $mon, $year, $wday, $yday, $isdst ) =
82 log_error("Invalid release date format: $release_date. Using "
83 . BROWSER_RELEASE_DATE . " instead.");
84 $release_date = BROWSER_RELEASE_DATE;
86 $rel_year = substr $release_date, 0, 4;
87 $rel_mon = substr $release_date, 4, 2;
88 $rel_day = substr $release_date, 6, 2;
91 die "release year in the future" if ( $year < $rel_year );
92 die "release month in the future"
93 if ( ( $year == $rel_year ) and ( $mon < $rel_mon ) );
94 die "release day in the future"
95 if ( ( $year == $rel_year )
96 and ( $mon == $rel_mon )
97 and ( $mday < $rel_day ) );
99 my @c_time = (0, 0, 0, $rel_day, $rel_mon - 1, $rel_year - 1900, 0, 0, 0);
100 my $c_seconds = &timelocal( @c_time );
102 $c_seconds = $now - (int rand ($now - $c_seconds));
103 @c_time = localtime $c_seconds;
104 ($sec, $min, $hour, $c_day, $c_mon, $c_year, $wday, $yday, $isdst) = @c_time;
109 die "Compilation year in the future" if ( $year < $c_year );
110 die "Compilation month in the future"
111 if ( ( $year == $c_year ) and ( $mon < $c_mon ) );
112 die "Compilation day in the future"
113 if ( ( $year == $c_year ) and ( $mon == $c_mon ) and ( $mday < $c_day ) );
115 return sprintf "%.2i%.2i%.2i", $c_year, $c_mon, $c_day;
118 sub generate_language_settings() {
122 my $language_i = int rand (@languages);
123 my $accept_language = $languages[$language_i];
124 $accept_language =~ tr/[A-Z]/[a-z]/;
126 return ($languages[$language_i], $accept_language);
129 sub generate_platform_and_os() {
135 architectures => [ 'i386', 'amd64', 'sparc64', 'alpha' ],
136 order_is_inversed => 0,
141 architectures => [ 'i386', 'amd64', 'sparc64', 'alpha' ],
142 order_is_inversed => 0,
147 architectures => [ 'i386', 'amd64', 'sparc64', 'alpha' ],
148 order_is_inversed => 0,
153 architectures => [ 'i586', 'i686', 'x86_64' ],
154 order_is_inversed => 0,
159 architectures => [ 'i86pc', 'sun4u' ],
160 order_is_inversed => 0,
164 platform => 'Macintosh',
165 architectures => [ 'PPC', 'Intel' ],
166 order_is_inversed => 1,
170 platform => 'Windows',
171 architectures => [ 'NT 5.1' ],
172 order_is_inversed => 0,
178 foreach my $os_name ( keys %os_data ) {
179 push @os_names, ($os_name) x $os_data{$os_name}{'karma'}
180 if $os_data{$os_name}{'karma'};
183 my $os_i = int rand(@os_names);
184 my $os = $os_names[$os_i];
185 my $arch_i = int rand( @{ $os_data{$os}{'architectures'} } );
186 my $arch = $os_data{$os}{'architectures'}[$arch_i];
188 my $platform = $os_data{$os}{'platform'};
191 $os_or_cpu = sprintf "%s %s",
192 $os_data{$os}{'order_is_inversed'} ? ( $arch, $os ) : ( $os, $arch );
194 return $platform, $os_or_cpu;
197 sub generate_firefox_user_agent() {
200 our $browser_version;
201 our $browser_revision;
202 our $browser_release_date;
204 my $mozillaversion = '5.0';
207 my $creation_time = generate_creation_time($browser_release_date);
208 my ( $locale, $accept_language ) = generate_language_settings();
209 my ( $platform, $os_or_cpu ) = generate_platform_and_os;
211 my $firefox_user_agent =
212 sprintf "Mozilla/%s (%s; %s; %s; %s; rv:%s) Gecko/%s Firefox/%s",
213 $mozillaversion, $platform, $security, $os_or_cpu, $locale, $browser_revision,
214 $creation_time, $browser_version;
216 return $accept_language, $firefox_user_agent;
226 my ( $sec, $min, $hour, $mday, $mon, $year, $wday, $yday, $isdst ) =
230 my $logtime = sprintf "%i/%.2i/%.2i %.2i:%.2i", $year, $mon, $mday, $hour,
233 return if $no_logging;
235 open(my $log_fd, ">>" . $logfile) || die "Writing " . $logfile . " failed";
236 printf $log_fd UAGEN_VERSION . " ($logtime) $message\n";
244 $message = "Error: $message";
245 log_to_file($message);
251 sub write_action_file() {
255 our $accept_language;
256 our $no_hide_accept_language;
257 our $action_injection;
259 my $action_file_content = '';
262 if ($action_injection){
263 open($actionfile_fd, $action_file)
264 or log_error "Reading action file $action_file failed!";
265 while (<$actionfile_fd>) {
266 s@(hide-accept-language\{).*?(\})@$1$accept_language$2@;
267 s@(hide-user-agent\{).*?(\})@$1$user_agent$2@;
268 $action_file_content .= $_;
270 close($actionfile_fd);
272 $action_file_content = "{";
273 $action_file_content .= sprintf "+hide-accept-language{%s} \\\n",
274 $accept_language unless $no_hide_accept_language;
275 $action_file_content .= sprintf " +hide-user-agent{%s} \\\n}\n/\n",
278 open($actionfile_fd, ">" . $action_file)
279 or log_error "Writing action file $action_file failed!";
280 print $actionfile_fd $action_file_content;
281 close($actionfile_fd);
286 sub write_prefs_file() {
288 our $mozilla_prefs_file;
290 our $accept_language;
293 my $prefs_file_content = '';
296 if (open($prefsfile_fd, $mozilla_prefs_file)) {
298 while (<$prefsfile_fd>) {
299 s@user_pref\(\"general.useragent.override\",.*\);\n?@@;
300 s@user_pref\(\"intl.accept_languages\",.*\);\n?@@;
301 $prefs_file_content .= $_;
303 close($prefsfile_fd);
305 log_error "Reading prefs file $mozilla_prefs_file failed. Creating a new file!";
308 $prefs_file_content .=
309 sprintf("user_pref(\"general.useragent.override\", \"%s\");\n", $user_agent) .
310 sprintf("user_pref(\"intl.accept_languages\", \"%s\");\n", $accept_language)
313 open($prefsfile_fd, ">" . $mozilla_prefs_file)
314 or log_error "Writing prefs file $mozilla_prefs_file failed!";
315 print $prefsfile_fd $prefs_file_content;
316 close($prefsfile_fd);
320 sub VersionMessage() {
321 printf UAGEN_VERSION . "\n" . 'Copyright (C) 2006-2009 Fabian Keil <fk@fabiankeil.de> ' .
322 "\nhttp://www.fabiankeil.de/sourcecode/uagen/\n";
329 our $browser_version;
330 our $browser_revision;
331 our $browser_release_date;
334 our $mozilla_prefs_file;
336 my $comma_separated_languages;
338 $loop = $loop ? ' ' . $loop : '';
339 $mozilla_prefs_file = $mozilla_prefs_file ? ' ' . $mozilla_prefs_file : '';
341 $comma_separated_languages .= $_ . ",";
343 chop $comma_separated_languages;
349 Options and their default values if there are any:
350 [--action-file $action_file]
352 [--browser-release-date $browser_release_date]
353 [--browser-revision $browser_revision]
354 [--browser-version $browser_version]
357 [--language-overwrite $comma_separated_languages]
361 [--no-hide-accept-language]
363 [--prefs-file$mozilla_prefs_file]
366 [--sleeping-time $sleeping_time]
368 see "perldoc $0" for more information
377 my $no_action_file = NO_ACTION_FILE;
379 our $silent = SILENT;
380 our $no_logging = NO_LOGGING;
381 our $logfile = UAGEN_LOGFILE;
382 our $action_file = ACTION_FILE;
383 our $browser_version = BROWSER_VERSION;
384 our $browser_revision = BROWSER_REVISION;
385 our $browser_release_date = BROWSER_RELEASE_DATE;
386 our $sleeping_time = SLEEPING_TIME;
388 our $no_hide_accept_language = 0;
389 our $action_injection = 0;
392 our ( $accept_language, $user_agent );
393 our $mozilla_prefs_file = MOZILLA_PREFS_FILE;
394 our $clean_prefs = 0;
396 GetOptions('logfile=s' => \$logfile,
397 'action-file=s' => \$action_file,
398 'language-overwrite=s@' => \@languages,
399 'silent|quiet' => \$silent,
400 'no-hide-accept-language' => \$no_hide_accept_language,
401 'no-logfile' => \$no_logging,
402 'no-action-file' => \$no_action_file,
403 'browser-version=s' => \$browser_version,
404 'browser-revision=s' => \$browser_revision,
405 'browser-release-date=s' => \$browser_release_date,
406 'action-injection' => \$action_injection,
408 'sleeping-time' => \$sleeping_time,
409 'prefs-file=s' => \$mozilla_prefs_file,
410 'clean-prefs-file' => \$clean_prefs,
412 'version' => sub {VersionMessage() && exit(0)}
416 @languages = split(/,/,join(',',@languages));
418 @languages = LANGUAGES;
421 srand( time ^ ( $$ + ( $$ << 15 ) ) );
425 ( $accept_language, $user_agent ) = generate_firefox_user_agent();
427 print "$user_agent\n" unless $silent;
429 write_action_file() unless $no_action_file;
430 write_prefs_file() if $mozilla_prefs_file;
432 log_to_file "Generated User-Agent: $user_agent";
434 } while ($loop && sleep($sleeping_time * 60));
442 B<uagen> - A Firefox User-Agent generator for Privoxy and Mozilla browsers
446 B<uagen> [B<--action-file> I<action_file>] [B<--action-injection>]
447 [B<--browser-release-date> I<browser_release_date>]
448 [B<--browser-revision> I<browser_revision>]
449 [B<--browser-version> I<browser_version>]
450 [B<--clean-prefs-file>]
451 [B<--help>] [B<--language-overwrite> I<language(s)>]
452 [B<--logfile> I<logfile>] [B<--loop>] [B<--no-action-file>] [B<--no-logfile>]
453 [B<--prefs-file> I<prefs_file>]
454 [B<--quiet>] [B<--sleeping-time> I<minutes>] [B<--silent>] [B<--version>]
458 B<uagen> generates a fake Firefox User-Agent and writes it into a Privoxy action file
459 as parameter for Privoxy's B<hide-user-agent> action. Operating system, architecture,
460 platform, language and build date are randomized.
462 The generated language is also used as parameter for the
463 B<hide-accept-language> action which is understood by Privoxy since
466 Additionally the User-Agent can be written into prefs.js files which are
467 used by many Mozilla browsers.
471 B<--action-file> I<action_file> Privoxy action file to write the
472 generated actions into. Default is /etc/privoxy/user-agent.action.
474 B<--action-injection> Don't generate a new action file from scratch,
475 but read an old one and just replace the action values. Useful
476 to keep custom URL patterns. For this to work, the action file
477 has to be already present. B<uagen> neither checks the syntax
478 nor cares if all actions are present. Garbage in, garbage out.
480 B<--browser-release-date> I<browser_release_date> Date when the faked
481 browser version was first released, format is YYYYMMDD. B<uagen> will
482 pick a date between the release date and the actual date to use it as
483 build time. Some sanity checks are done, but you shouldn't rely on them.
485 B<--browser-revision> I<browser_revision> Use a custom revision.
486 B<uagen> will use it without any sanity checks.
488 B<--browser-version> I<browser_version> Use a custom browser version.
489 B<uagen> will use it without any sanity checks.
491 B<--clean-prefs-file> The I<prefs_file> is read and the variables
492 B<general.useragent.override> and B<intl.accept_languages> are removed.
493 Only effective if I<prefs_file> is set, and only useful if you want
494 to use the browser's defaults again.
496 B<--help> List command line options and exit.
498 B<--language-overwrite> I<language(s)> Comma separated list of language codes
499 to overwrite the default values. B<uagen> chooses one of them for the generated
500 User-Agent, by default the chosen language in lower cases is also used as
501 B<hide-accept-language> parameter.
503 B<--logfile> I<logfile> Logfile to save error messages and the generated
504 User-Agents. Default is /var/log/uagen.log.
506 B<--loop> Don't exit after the generation of the action file. Sleep for
507 a while and generate a new one instead. Useful if you don't have cron(8).
509 B<--no-logfile> Don't log anything.
511 B<--no-action-file> Don't write the action file.
513 B<--no-hide-accept-language> Stay compatible with Privoxy 3.0.3
514 and don't generate the B<hide-accept-language> action line. You should
515 really update your Privoxy version instead.
517 B<--prefs-file> I<prefs_file> Use the generated User-Agent to set the
518 B<general.useragent.override> variable in the Mozilla preference file
519 I<prefs_file>, The B<intl.accept_languages> variable will be set as well.
521 Firefox's preference file is usually located in
522 ~/.mozilla/firefox/*.default/prefs.js. Note that Firefox doesn't reread
523 the file once it is running.
525 B<--quiet> Don't print the generated User-Agent to the console.
527 B<--sleeping-time> I<minutes> Time to sleep. Only effective if used with B<--loop>.
529 B<--silent> Don't print the generated User-Agent to the console.
531 B<--version> Print version and exit.
533 The second dash is optional, options can be shortened, as long as there are
536 =head1 PRIVOXY CONFIGURATION
538 In Privoxy's configuration file the line:
540 actionsfile user-agent.action
542 should be added after:
544 actionfile default.action
548 actionfile user.action
550 This way the user can still use custom User-Agents
551 in I<user.action>. I<user-agent> has to be the name
552 of the generated action file.
554 If you are using Privoxy 3.0.6 or earlier, don't add the ".action" extension.
558 Without any options, B<uagen> creates an action file like:
560 {+hide-accept-language{en-ca} \
561 +hide-user-agent{Mozilla/5.0 (X11; U; OpenBSD i386; en-CA; rv:1.8.0.4) Gecko/20060628 Firefox/1.5.0.4} \
565 with the --no-accept-language option the generated file
566 could look like this one:
568 {+hide-user-agent{Mozilla/5.0 (X11; U; FreeBSD i386; de-DE; rv:1.8.0.4) Gecko/20060720 Firefox/1.5.0.4} \
574 If the browser opens an encrypted connection, Privoxy can't inspect
575 the content and the browser's headers reach the server unmodified.
576 It is the user's job to use Privoxy's limit-connect action to make sure
577 there are no encrypted connections to untrusted sites.
579 Mozilla users can alter the browser's User-Agent with the
580 B<--prefs-file> option. But note that the preference file is only read
581 on startup. If the browser is already running, B<uagen's> changes will be ignored.
583 Hiding the User-Agent is pointless if the browser accepts all
584 cookies or even is configured for remote maintenance through Flash,
585 JavaScript, Java or similar security problems.
589 Some parameters can't be specified at the command line.
597 Fabian Keil <fk@fabiankeil.de>
599 http://www.fabiankeil.de/sourcecode/uagen/
601 http://www.fabiankeil.de/blog-surrogat/2006/01/26/firefox-user-agent-generator.html (German)