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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
|
#-*- perl -*-
#
# Copyright (C) 2001,2002,2003 Ken'ichi Fukamachi
# All rights reserved.
#
# $FML: Base.pm,v 1.21 2003/02/09 12:31:46 fukachan Exp $
#
package FML::Restriction::Base;
use vars qw($debug @ISA @EXPORT @EXPORT_OK);
use strict;
use Carp;
=head1 NAME
FML::Restriction::Base -- define safe data representations
=head1 SYNOPSIS
use FML::Restriction::Base;
my $safe = new FML::Restriction::Base;
my $regexp = $safe->regexp( 'type' );
if ($data =~ /^($regexp)$/) {
# o.k. do something ...
}
or
if ($safe->regexp_match('address', $data)) {
# o.k. do something ...
}
=head1 DESCRIPTION
FML::Restriction::Base provides data regexp considered as safe.
ALL FML MODULES SHOULD USE THIS MODULE if it needs to check whether
a variable is safe or not.
=head1 METHODS
=head2 C<new($args)>
usual constructor.
=cut
# Descriptions: constructor.
# avoid default fml new() since we do not need it.
# Arguments: OBJ($self) HASH_REF($args)
# Side Effects: none
# Return Value: OBJ
sub new
{
my ($self, $args) = @_;
my ($type) = ref($self) || $self;
my $me = {};
return bless $me, $type;
}
=head1 Basic Parameter Definitions for common use
We permit the variable name representation as a subset of RFC
definitions for conveninece and security.
=head2 domain name
A domain name is case insensitive (see RFC). For example,
fml.org
FML.org
123.f-m-l.org
=head2 user
Very restricted since strict 822 or 2822 representation is very
difficult, so may be insecure in some cases.
By the way, "_" is derived from lotus notes ? Anyway we permit "_" for
convenience.
=head2 mail address
Of cource, "user@domain", described above.
=cut
my $domain_regexp = '[-A-Za-z0-9\.]+';
my $user_regexp = '[-A-Za-z0-9\._\+]+';
my $command_regexp = '[-A-Za-z0-9_]+';
my $file_regexp = '[-A-Za-z0-9_]+';
my $dir_regexp = '[-A-Za-z0-9_]+';
my $option_regexp = '[-A-Za-z0-9]+';
my %basic_variable =
(
# address, user and domain et.al.
'address' => $user_regexp.'\@'.$domain_regexp,
'address_specified' => $user_regexp.'\@'.$domain_regexp,
'address_selected' => $user_regexp.'\@'.$domain_regexp,
'domain' => $domain_regexp,
'user' => $user_regexp,
'ml_name' => $user_regexp,
'ml_name_specified' => $user_regexp,
# fml specific parameters
'action' => $command_regexp,
'command' => $command_regexp,
'navi_command' => $command_regexp,
'article_id' => '\d+',
# file, directory et.al.
'directory' => $dir_regexp,
'file' => $file_regexp,
'map' => $file_regexp,
# unix command switch
'command_line_options' => $option_regexp,
);
=head2 basic_variable()
return basic variable regexp list as HASH_REF.
=cut
# Descriptions: return basic variable regexp list as HASH_REF.
# Arguments: OBJ($self)
# Side Effects: none
# Return Value: HASH_REF
sub basic_variable
{
my ($self) = @_;
return \%basic_variable;
}
=head2 regexp( class )
return the allowed regexp for C<class>.
=cut
# Descriptions: return allowed regexp for $class.
# Arguments: OBJ($self) STR($class)
# Side Effects: none
# Return Value: STR or UNDEF
sub regexp
{
my ($self, $class) = @_;
if (defined $basic_variable{ $class }) {
return $basic_variable{ $class };
}
else {
return undef;
}
}
=head2 regexp_match( class, string )
check if C<string> matches regexp specified by C<class>.
return 1 or undef.
my $obj = new FML::Restriction::Base;
if ($obj->regexp_match( "address", $address ) {
... do something ...
}
C<regexp_match> can handle some special class not based on regexp:
C<fullpath>.
=cut
# Descriptions: return allowed regexp for $class.
# Arguments: OBJ($self) STR($class) STR($string)
# Side Effects: none
# Return Value: 1 or UNDEF
sub regexp_match
{
my ($self, $class, $string) = @_;
if (defined $class && defined $string) {
if ($class eq 'fullpath') {
return $self->_regexp_match_fullpath($string);
}
if (defined $basic_variable{ $class }) {
my $regexp = $basic_variable{ $class };
if ($string =~ /^($regexp)$/) {
return 1;
}
else {
return undef;
}
}
else {
return undef;
}
}
return undef;
}
# Descriptions: return allowed regexp for full path.
# XXX special handling of fully path-ed directory.
# Arguments: OBJ($self) STR($string)
# Side Effects: none
# Return Value: 1 or UNDEF
sub _regexp_match_fullpath
{
my ($self, $string) = @_;
my $regexp = $basic_variable{ 'directory' };
my $level = 0;
my $ok = 0;
# remove volume of M$-DOS style.
$string =~ s/^[A-Za-z]://;
for my $dir (split(/\/|\\/, $string)) {
$level++;
if ($dir =~ /^($regexp)$/ || $dir =~ /^\s*$/o) {
$ok++;
}
}
return( $level == $ok ? 1 : undef );
}
#
# debug
#
if ($0 eq __FILE__) {
for my $k (keys %basic_variable) {
printf "%-20s => %s\n", $k, $basic_variable{ $k };
}
}
=head1 CODING STYLE
See C<http://www.fml.org/software/FNF/> on fml coding style guide.
=head1 AUTHOR
Ken'ichi Fukamachi
=head1 COPYRIGHT
Copyright (C) 2001,2002,2003 Ken'ichi Fukamachi
All rights reserved. This program is free software; you can
redistribute it and/or modify it under the same terms as Perl itself.
=head1 HISTORY
FML::Process::Configure first appeared in fml8 mailing list driver package.
See C<http://www.fml.org/> for more details.
=cut
1;
|
