From 8de670263c16a8b58fbde87d76e3e33da0ddf942 Mon Sep 17 00:00:00 2001 From: "http://schmonz.livejournal.com/" Date: Mon, 28 Jul 2008 23:57:26 -0400 Subject: document unixauth.pm --- doc/plugins/contrib/unixauth.mdwn | 154 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 154 insertions(+) create mode 100644 doc/plugins/contrib/unixauth.mdwn (limited to 'doc/plugins') diff --git a/doc/plugins/contrib/unixauth.mdwn b/doc/plugins/contrib/unixauth.mdwn new file mode 100644 index 000000000..12f885c33 --- /dev/null +++ b/doc/plugins/contrib/unixauth.mdwn @@ -0,0 +1,154 @@ +[[!template id=plugin name=unixauth core=0 author="[[schmonz]]"]] +[[!tag type/auth]] + +This plugin authenticates users against the Unix user database. It presents a similar UI to [[plugins/passwordauth]], but simpler, as there's no need to be able to register or change one's password. + +[pwauth](http://www.unixpapa.com/pwauth/) must be installed and working. In particular, it must be configured to recognize the UID of the calling web server, or authentication will always fail. Set `pwauth_path` to the full path of your pwauth binary. + +As [with passwordauth](/security/#index14h2), be wary of sending usernames and passwords in cleartext. Unlike with passwordauth, sniffing these credentials can get an attacker much further than mere wiki access. SSL with this plugin is a __must__. + +[[!toggle id="code" text="unixauth.pm"]] + +[[!toggleable id="code" text=""" + + #!/usr/bin/perl + # Ikiwiki unixauth authentication. + package IkiWiki::Plugin::unixauth; + + use warnings; + use strict; + use IkiWiki 2.00; + + sub import { #{{{ + hook(type => "formbuilder_setup", id => "unixauth", + call => \&formbuilder_setup); + hook(type => "formbuilder", id => "unixauth", + call => \&formbuilder); + hook(type => "sessioncgi", id => "unixauth", call => \&sessioncgi); + } # }}} + + # Checks if a string matches a user's password, and returns true or false. + sub checkpassword ($$;$) { #{{{ + my $user=shift; + my $password=shift; + my $field=shift || "password"; + + # It's very important that the user not be allowed to log in with + # an empty password! + if (! length $password) { + return 0; + } + + my $ret=0; + if (! exists $config{pwauth_path}) { + $config{pwauth_path}="/usr/libexec/pwauth"; + } + open PWAUTH, "|$config{pwauth_path}" or die("Could not run pwauth"); + print PWAUTH "$user\n$password\n"; + close PWAUTH; + $ret=!($?>>8); + + if ($ret) { + my $userinfo=IkiWiki::userinfo_retrieve(); + if (! length $user || ! defined $userinfo || + ! exists $userinfo->{$user} || ! ref $userinfo->{$user}) { + IkiWiki::userinfo_setall($user, { + 'email' => '', + 'regdate' => time, + }); + } + } + + return $ret; + } #}}} + + sub formbuilder_setup (@) { #{{{ + my %params=@_; + + my $form=$params{form}; + my $session=$params{session}; + my $cgi=$params{cgi}; + + if ($form->title eq "signin") { + $form->field(name => "name", required => 0); + $form->field(name => "password", type => "password", required => 0); + + if ($form->submitted) { + my $submittype=$form->submitted; + # Set required fields based on how form was submitted. + my %required=( + "Login" => [qw(name password)], + ); + foreach my $opt (@{$required{$submittype}}) { + $form->field(name => $opt, required => 1); + } + + # Validate password against name for Login. + if ($submittype eq "Login") { + $form->field( + name => "password", + validate => sub { + checkpassword($form->field("name"), shift); + }, + ); + } + + elsif ($submittype eq "Login") { + $form->field( + name => "name", + validate => sub { + my $name=shift; + length $name && + IkiWiki::userinfo_get($name, "regdate"); + }, + ); + } + } + else { + # First time settings. + $form->field(name => "name"); + if ($session->param("name")) { + $form->field(name => "name", value => $session->param("name")); + } + } + } + elsif ($form->title eq "preferences") { + $form->field(name => "name", disabled => 1, + value => $session->param("name"), force => 1, + fieldset => "login"); + $form->field(name => "password", disabled => 1, type => "password", + fieldset => "login"), + } + } + + sub formbuilder (@) { #{{{ + my %params=@_; + + my $form=$params{form}; + my $session=$params{session}; + my $cgi=$params{cgi}; + my $buttons=$params{buttons}; + + if ($form->title eq "signin") { + if ($form->submitted && $form->validate) { + if ($form->submitted eq 'Login') { + $session->param("name", $form->field("name")); + IkiWiki::cgi_postsignin($cgi, $session); + } + } + } + elsif ($form->title eq "preferences") { + if ($form->submitted eq "Save Preferences" && $form->validate) { + my $user_name=$form->field('name'); + } + } + } #}}} + + sub sessioncgi ($$) { #{{{ + my $q=shift; + my $session=shift; + } #}}} + + 1 + +"""]] -- cgit v1.2.3 From a02c3f46ea79313a4e0f6df924efac067b0fd177 Mon Sep 17 00:00:00 2001 From: Joey Hess Date: Tue, 29 Jul 2008 15:39:01 -0400 Subject: initial draft --- IkiWiki/Plugin/autoindex.pm | 55 +++++++++++++++++++++++++++++++++++++++++++++ doc/plugins/autoindex.mdwn | 7 ++++++ templates/autoindex.tmpl | 1 + 3 files changed, 63 insertions(+) create mode 100644 IkiWiki/Plugin/autoindex.pm create mode 100644 doc/plugins/autoindex.mdwn create mode 100644 templates/autoindex.tmpl (limited to 'doc/plugins') diff --git a/IkiWiki/Plugin/autoindex.pm b/IkiWiki/Plugin/autoindex.pm new file mode 100644 index 000000000..0a8d90701 --- /dev/null +++ b/IkiWiki/Plugin/autoindex.pm @@ -0,0 +1,55 @@ +#!/usr/bin/perl +package IkiWiki::Plugin::autoindex; + +use warnings; +use strict; +use IkiWiki 2.00; +use Encode; + +sub import { #{{{ + hook(type => "refresh", id => "autoindex", call => \&refresh); +} # }}} + +sub genindex ($) { #{{{ + my $page=shift; + my $file=$page.".".$config{default_pageext}; + my $template=template("autoindex.tmpl"); + $template->param(page => $page); + writefile($file, $config{srcdir}, $template->output); +} #}}} + +sub refresh () { #{{{ + eval q{use File::Find}; + error($@) if $@; + + my (%pages, %dirs); + find({ + no_chdir => 1, + wanted => sub { + $_=decode_utf8($_); + if (IkiWiki::file_pruned($_, $config{srcdir})) { + $File::Find::prune=1; + } + elsif (! -l $_) { + my ($f)=/$config{wiki_file_regexp}/; # untaint + return unless defined $f; + $f=~s/^\Q$config{srcdir}\E\/?//; + return unless length $f; + if (! -d _) { + $pages{pagename($f)}=1; + } + else { + $dirs{$f}=1; + } + } + } + }, $config{srcdir}); + + foreach my $dir (keys %dirs) { + if (! exists $pages{$dir}) { + genindex($dir); + } + } +} #}}} + +1 diff --git a/doc/plugins/autoindex.mdwn b/doc/plugins/autoindex.mdwn new file mode 100644 index 000000000..66e0163c2 --- /dev/null +++ b/doc/plugins/autoindex.mdwn @@ -0,0 +1,7 @@ +[[!template id=plugin name=autoindex core=0 author="[[Joey]]"]] +[[!tag type/useful]] + +This plugin searches for [[SubPages|ikiwiki/subpage]] with a missing parent +page, and generates a parent page for them. The generated page content is +controlled by the autoindex [[template|wikitemplates]], which by default, +uses a [[map]] to list the SubPages. diff --git a/templates/autoindex.tmpl b/templates/autoindex.tmpl new file mode 100644 index 000000000..d5ec3b8ee --- /dev/null +++ b/templates/autoindex.tmpl @@ -0,0 +1 @@ +[[!map pages="/* and ! /*/*"]] -- cgit v1.2.3 From d6c73e9ef6dcd89ade9ca64755d683ac88d46ae7 Mon Sep 17 00:00:00 2001 From: Joey Hess Date: Tue, 29 Jul 2008 15:40:07 -0400 Subject: rename discussion page to match plugin name --- doc/plugins/plaintext/discussion.mdwn | 33 --------------------------------- doc/plugins/txt/discussion.mdwn | 33 +++++++++++++++++++++++++++++++++ 2 files changed, 33 insertions(+), 33 deletions(-) delete mode 100644 doc/plugins/plaintext/discussion.mdwn create mode 100644 doc/plugins/txt/discussion.mdwn (limited to 'doc/plugins') diff --git a/doc/plugins/plaintext/discussion.mdwn b/doc/plugins/plaintext/discussion.mdwn deleted file mode 100644 index 6b907e65c..000000000 --- a/doc/plugins/plaintext/discussion.mdwn +++ /dev/null @@ -1,33 +0,0 @@ -I guess the reason I never thought to write this is when I put a .txt file -in ikiwiki, I'm happy enough to see it copied through unchanged. - -I guess the advantage of using this plugin is that you get the page wrapper -around the preformatted text, and could even inline such a page. - -There is not currently a good way to turn off some processing steps for -some page types. It's either all or nothing. The patch in -[[todo/format_escape]] might allow a formatter to register its own special -version of htmllink that didn't do anything, but would that be enough? - ---[[Joey]] - -[Here](http://www.gmcmanus.org/plaintext.pm) is an alternate approach. -It encodes entities using a filter hook, before wikilinks are linkified. -So wikilinks turn up as links. -It also uses URI::Find to turn URIs into links. - -I'm not very familiar with Perl, so this code could be improved. - ---Gabriel - -I like this approach! It sidesteps the annoying problem, and it actually -makes the .txt format genuinely wiki-like, by allowing wikilinks and -preprocessor directices. - -The only thing I am not sure about is the conversion of external urls to -hyperlinks. - -Can you please add a copyright/license statemnt to the top of the plugin? -If you do, I'll add it to ikiwiki. Thanks! --[[Joey]] - -> I've added copyright and license (GPLv2 or later). --Gabriel diff --git a/doc/plugins/txt/discussion.mdwn b/doc/plugins/txt/discussion.mdwn new file mode 100644 index 000000000..6b907e65c --- /dev/null +++ b/doc/plugins/txt/discussion.mdwn @@ -0,0 +1,33 @@ +I guess the reason I never thought to write this is when I put a .txt file +in ikiwiki, I'm happy enough to see it copied through unchanged. + +I guess the advantage of using this plugin is that you get the page wrapper +around the preformatted text, and could even inline such a page. + +There is not currently a good way to turn off some processing steps for +some page types. It's either all or nothing. The patch in +[[todo/format_escape]] might allow a formatter to register its own special +version of htmllink that didn't do anything, but would that be enough? + +--[[Joey]] + +[Here](http://www.gmcmanus.org/plaintext.pm) is an alternate approach. +It encodes entities using a filter hook, before wikilinks are linkified. +So wikilinks turn up as links. +It also uses URI::Find to turn URIs into links. + +I'm not very familiar with Perl, so this code could be improved. + +--Gabriel + +I like this approach! It sidesteps the annoying problem, and it actually +makes the .txt format genuinely wiki-like, by allowing wikilinks and +preprocessor directices. + +The only thing I am not sure about is the conversion of external urls to +hyperlinks. + +Can you please add a copyright/license statemnt to the top of the plugin? +If you do, I'll add it to ikiwiki. Thanks! --[[Joey]] + +> I've added copyright and license (GPLv2 or later). --Gabriel -- cgit v1.2.3