summaryrefslogtreecommitdiff
path: root/scripts/vyos-strip-config.pl
blob: 7b1d9edea677314375dbbc13d83f106e584e1c2f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
#!/usr/bin/perl
#
# Removes private information from Vyatta config files.
#
# Copyright (C) 2011 Daniil Baturin <daniil@baturin.org>
#
# Permission is hereby granted, free of charge, to any person obtaining a copy of
# this software and associated documentation files (the "Software"), to deal in
# the Software without restriction, including without limitation the rights to
# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
# of the Software, and to permit persons to whom the Software is furnished to do
# so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.

# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.

use strict;
use Getopt::Long;

sub help {
        my $msg = <<EOL;
Strips off private information from Vyatta configs.

Usage: $0 </path/to/config>
       $0 --stdin < </path/to/config> (or "cat /path/to/config | $0 --stdin")

Options:
--stdin        Read config from standard input

--strict       Remove any private information (see details in options below).
               This is default behavior.

--loose        Remove only information specified in options below

--address      Strip off IPv4 and IPv6 addresses
--mac          Strip off MAC addresses
--domain       Strip off domain names
--hostname     Strip off system host and domain names
--username     Strip off user names
--dhcp         Strip off DHCP shared network and static mapping names
--asn          Strip off BGP ASNs
--lldp         Strip off LLDP location information
--snmp         Strip off SNMP location information

EOL
        print $msg;
}

my $inputFile           = undef;
my $stdin               = undef;
my $strict              = 1;
my $loose               = undef;
my $stripIP             = undef;
my $stripDomains        = undef;
my $stripHostname       = undef;
my $stripUsernames      = undef;
my $stripDHCP           = undef;
my $stripMAC            = undef;
my $stripOvpnSecrets    = undef;
my $stripASN            = undef;
my $stripLLDP           = undef;
my $stripSNMP           = undef;
my $keepPasswords       = undef;
my $keepKeys            = undef;
my $input               = undef;

GetOptions(
	"stdin"             => \$stdin,
	"loose"             => \$loose,
	"strict"            => \$strict,
	"address"           => \$stripIP,
	"domain"            => \$stripDomains,
	"hostname"          => \$stripHostname,
	"username"          => \$stripUsernames,
	"mac"               => \$stripMAC,
	"dhcp"              => \$stripDHCP,
        "openvpn"           => \$stripOvpnSecrets,
	"asn"               => \$stripASN,
	"lldp"              => \$stripLLDP,
	"snmp"              => \$stripSNMP,
	"keep-passwords"    => \$keepPasswords,
	"keep-keys"         => \$keepKeys
);

$strict = 0 if $loose;

if ($strict) {
        $stripIP = 1;
        $stripDomains = 1;
        $stripHostname = 1;
        $stripUsernames = 1;
        $stripDHCP = 1;
        $stripMAC = 1;
        $stripOvpnSecrets = 1;
        $stripASN = 1;
        $stripLLDP = 1;
        $stripSNMP = 1;
}

## Get config

$inputFile = @ARGV[0];

if ($stdin) {
	while (<>) {
		$input .= $_;
	}
} elsif ($inputFile) {
	open (HANDLE, "<$inputFile") or die "Can not open config file $inputFile";
	while (<HANDLE>) {
		$input .= $_;
	}
	close (HANDLE) or die $!;
} else {
	help();
	exit(0);
}

## Everybody stand back, I know regular expressions

# Strip passwords
$input =~ s/password \S+/password xxxxxx/g if !($keepPasswords);

# Strip public key information
$input =~ s/public-keys \S+/public-keys xxxx\@xxx.xxx/g if !($keepKeys);
$input =~ s/(type 'ssh-rsa'|type 'ssh-dss')/type ssh-xxx/g if !($keepKeys);
$input =~ s/ key \S+/ key xxxxxx/g if !($keepKeys);

# Strip MAC addresses
$input =~ s/([0-9A-F]{2}\:){3}([0-9A-F]{2}((\:{0,1})){3})/XX:XX:XX:$2/gi if $stripMAC;

# Strip IPv4 addresses
$input =~ s/\d+\.\d+\.(\d+)\.(\d+)/xxx.xxx.$1.$2/g if $stripIP;

# Strip IPv6 addresses
$input =~ s/ (([0-9a-f]{1,4}\:){2})(\S+)/ xxxx:xxxx:$3/gi if $stripIP;

# Strip host-name, domain-name, and domain-search
$input =~ s/(host-name|domain-name|domain-search) \S+/$1 xxxxxx/g if $stripHostname;

# Strip user-names
$input =~ s/(user|username|user-id|full-name) \S+/$1 xxxxxx/g if $stripUsernames;

# Strip DHCP static-mapping and shared network names
$input =~ s/(shared-network-name|static-mapping) \S+/$1 xxxxxx/g if $stripDHCP;

# Strip host/domain names
$input =~ s/ (peer|remote-host|local-host|server) ([\w-]+\.)+[\w-]+/ $1 xxxxx.tld/g if $stripDomains;

# Strip OpenVPN secrets
$input =~ s/(shared-secret-key-file|ca-cert-file|cert-file|dh-file|key-file|client) (\S+)/$1 xxxxxx/g if $stripOvpnSecrets;

# Strip IPSEC secrets
$input =~ s/pre-shared-secret \S+/pre-shared-secret xxxxxx/g if !($keepKeys);

# Strip BGP ASNs
$input =~ s/(bgp|remote-as) (\d+)/$1 XXXXXX/g if $stripASN;

# Strip LLDP location parameters
$input =~ s/(altitude|datum|latitude|longitude|ca-value|country-code) (\S+)/$1 xxxxxx/g if $stripLLDP;

# Strip SNMP location
$input =~ s/(location) \S+/$1 xxxxxx/g if $stripSNMP;

print $input;

exit(0);