From 169ff1d102c6d2a97f2288b4395143f46f8b015c Mon Sep 17 00:00:00 2001 From: Andrea Luzzardi Date: Thu, 28 Dec 2006 20:58:43 +0000 Subject: [PATCH] Documentation update --- Makefile | 2 +- doc/{configuration => CONFIGURATION} | 0 doc/FAQ | 21 +++++++++++++ doc/{installation => INSTALLATION} | 44 +++++++++++++++++++++++++++ doc/{upgrading => UPGRADING} | 0 doc/pusb_adm.1.gz | Bin 722 -> 722 bytes doc/pusb_check.1.gz | Bin 839 -> 840 bytes doc/pusb_hotplug.1.gz | Bin 606 -> 607 bytes 8 files changed, 66 insertions(+), 1 deletion(-) rename doc/{configuration => CONFIGURATION} (100%) create mode 100644 doc/FAQ rename doc/{installation => INSTALLATION} (78%) rename doc/{upgrading => UPGRADING} (100%) diff --git a/Makefile b/Makefile index 0e14092..76f8b4b 100644 --- a/Makefile +++ b/Makefile @@ -41,7 +41,7 @@ CONFS := doc/pusb.conf-dist CONFS_DEST := $(DESTDIR)/etc/pusb # Doc -DOCS := doc/installation doc/configuration doc/upgrading +DOCS := doc/INSTALLATION doc/CONFIGURATION doc/UPGRADING doc/FAQ DOCS_DEST := $(DESTDIR)/usr/share/doc/pamusb # Man diff --git a/doc/configuration b/doc/CONFIGURATION similarity index 100% rename from doc/configuration rename to doc/CONFIGURATION diff --git a/doc/FAQ b/doc/FAQ new file mode 100644 index 0000000..37c76f3 --- /dev/null +++ b/doc/FAQ @@ -0,0 +1,21 @@ +====== Frequently Asked Questions ====== + +> Q: Can I use my USB drive as usual ? +>> A: Yes. pam_usb only occupies a few kilobytes of the device's space. + +> Q: What if I lose or break my USB key ? Will I be able to log back in ? +>> A: Sure. Your usual password will be asked. + +> Q: How is the USB key identified ? +>> A: The USB device is both identified by its manufacturer attributes (vendor, +product, serial number) and by a few random bytes called one time pads that +pam_usb writes and updates on the USB device upon authentication. + +> Q: What if someone copies the content of my flash drive ? Will she/he be able +to log into my account ? +>> A: Even if that person manages to fake your device's attributes (vendor, +product, serial number, UUID), the one time pad they copied will be outdated as +soon as you authenticate. + +> Q: Is my USB drive compatible with pam_usb ? +>> A: About every USB flash drive will work with pam_usb. diff --git a/doc/installation b/doc/INSTALLATION similarity index 78% rename from doc/installation rename to doc/INSTALLATION index 4990768..85d2307 100644 --- a/doc/installation +++ b/doc/INSTALLATION @@ -5,6 +5,7 @@ an older version of pamusb. ===== Requirements ===== * Requirements for pam_usb and pusb_check: + * libpam * libhal-storage * libxml2 @@ -154,6 +155,49 @@ For instance, with GNOME: - Enter pusb_hotplug and press OK - Press Close +====== Troubleshooting ====== + +===== Log Analysis ===== + +Both pam_usb.so and pusb_hotplug use the syslog facility to log authentication +attempts. +This can be useful for GUI-driven applications (for instance GDM) where you +don't get to see console output. +Messages are logged with the AUTH facility, they are usually written to +/var/log/auth.log but may vary +depending on the operating system you're using. + +# tail -f /var/log/auth.log +pusb_hotplug[25429]: Device "sandisk" has been inserted. Performing +verification... +pusb_hotplug[25429]: Executing "/usr/bin/pusb_check -q -c /etc/pusb/pusb.conf -u +scox -s pusb_hotplug -a" +pam_usb[25485]: Authentication request for user "scox" (pusb_hotplug) +pam_usb[25485]: Device "sandisk" is connected (good). +pam_usb[25485]: Access granted. +pusb_hotplug[25429]: Authentication succeeded. Unlocking user "scox"... +pusb_hotplug[25429]: Unlocked. + +===== Enabling debug ===== + +Enabling debug messages may help you find out what's wrong. + +To enable them, edit /etc/pusb/pusb.conf and set the following option: + + + + +If you wish, you could enable debug messages only for a specific user, device or +service. +For instance, if you want to enable debug messages only for the sudo service, +you could do the following: + + + + + + + ====== It works - What next ? ====== * Have a look at the configuration documentation diff --git a/doc/upgrading b/doc/UPGRADING similarity index 100% rename from doc/upgrading rename to doc/UPGRADING diff --git a/doc/pusb_adm.1.gz b/doc/pusb_adm.1.gz index c2bb910f60240b5fcab1303f1abbede85bc010aa..2d26449e89236b23eb1bd9295296b9f7d6b82ccd 100644 GIT binary patch delta 704 zcmV;x0zduI1=0lvABzYGJ};D!2OxiKngFc@HYx#)Nc&-0r^!t&i8aTLY==^Q{mxE- zQZ}h-d-1(IFX!+c%<<8KXuYY0mzhv%10`y-!eb7r4fscYQVTs8@elkH#+UAz9Qv}CkcNW`)6r3VNGOIpEcIxZAMKTS}7FhHhLp;4$c4-`09v-=-+-v9GS5eU1M|}h-{}3GP|Lf z+l(DL>*fjLlOW%qqQidYN)U=7mR4pBuB~f9eN6$TiA;a^ZrQ85XRkxp z!gV-H`GESr(!ybmg=m#`BqJN5&xXN|;fpCpZ%4h^mb0)dEX_p6*KM4~I>-n3fP|Oo zHEj-A|K1o5Go2v|buGC7m2i+%#$ng1OX@S}VJ(${6#|X!mgt?fyL?&~?C1q#J)oXj zV?qpvYg!Uy+rt1mwAFtb5OyWK4HCz^jcE^ZQ1TD%vERQC?3=OFd~fv$qQY)jBQ=ML z(qUc6ta`>nIds+!LTM(+S55n6G)5g(NGfzgFz>cyviP2|M4=#8Nh5mWv?W+_ zCfj#KEu;z>DCsaqUd*p& m_iU_livn)irzc@^38yYIk6-C}k4BtYp0mFzMS|Zb1pojUrb~1H delta 704 zcmV;x0zduI1=0lvABzYGIF5yp2OxhTO@P({8ff6-Z;W3BR2K=Kxsf8Yl_$PkK`1}T%)~)`C zyoM32nvY5QqEeDW@nj(M5j4ou^ z(lBW>cwRr^!GQ!Ba!EW93NyB zp23+GHC}A1v>61#IeN@|sOVGe>Zk{kc3GxjpI_!6@1feKmX=T>n+PW6h*A!ry$b^6Imc6-q{x*ay zT!*ui52*huEga@ph*o(=GO{81Y#96)zM69Me$=~dIS%%AC2KK(;2c**OCiR2?tqa9Cp3Bq&|}#)>0{0A<*bKrX@kPJq)lzTfKh)VOP@IAaTswnD!tCCI8|c`~3^Sz8Oo+_g0@ED(sduQgf&% z9oCi1suw(zLudUUlxC8A)wEwmW7J`Vq(V0Y^KM%vi|;8*6bf>cG@>_7TY|-gR@J>| zvVB+7LaLyFlFoCMBK7pX`4U3MooNX%SyUp|=!fxX{0`@he^L(TG#a3-%17y6jXa1pojW$zLD< diff --git a/doc/pusb_check.1.gz b/doc/pusb_check.1.gz index 3bfc3784567a61400f5d9de20180a8a598cbd37d..7df7177b642f48450fb98f55a3eff07765baec11 100644 GIT binary patch delta 790 zcmV+x1L^$72FL~nABzYGKQEM#2O$h|OH+(7JwK=ov8`BBJI50H0v#Owz6XZ~2fxi=M!#%v zeV?Dsgpm0q+$^py#Haf7t7U@ozi)1{{3;jH)I!#(hqFzsPjv?W5c00%+i_`4tsAIy zhbN!mm<5pq(W8Ges>hQN^NbPnq)Qy(*o=DqOl0G^Gc7Bnc-CbqN ztJ|Az11gmPulv{$Lrh$YhKUQ>8VIekv1#dxkg1;R08OI}N^uoHdk(dZ9n{uAVFM|m z585=usT-_E4?Dra$nC_(n0R#Q5%H`;Yh!>`J+Ubn1h;<%MnMUOs)NDV#;JaH4+_## zoww;lUphVTa}u_*`q=}%=s+)3$Z;Nkt~mm+mEbeo>FByWsy!uu?pb@vj#<0-YjK@@ zxX8s%-?)dj0=yN?m-YqT%2it{CRJA3d>KCJsx`br&gI7sw zec*{8P#4xdyyAZC1NQ7{RcS{=S+^z~$wYh&nW=yMo(`4&HqA@^s?Yqi#E-~Z`wTwz zy`nC)HQ0ek@^Y$}=9}kQ+ban~k3oV5h=b#V&Ym{Cy1NK1Yxa$?CfsjyLuL zJ5LujEs*gl_0(pQPwl6>MC9Wae(VCKKDh72T{NK0wpvf)HdW<56X(=EiG$7T$;@f= zQ+0M;Ug9IS&HtXL45#;h<|6A*5s@AZ?eN&p01eiSlug!3uXM*7q|-h~$_}9oVL0Ny zUV0l{iIiG{(qPz6Xgam2?f#Hlq?qvuI|^i60*m|Qt;TeG$VfsUjnEYY_EbYRo88x zL4!^Otf1IHcnR-&W!}x@ukwSCt1B3yFVr#gdw2zgiX?WDA()(zCU z!_&`j!h*2^_FmXX!1EF;`HZ6S-GS!nEplP&0DV71W=TPg|L2VrrHjpCv zpiM)Zy1{z%uooTHq1Q#1-Y(0ZLGTWcpT_6{o z#L86KKg@qP6=OLqW3Z%-mRqlsC3+7P8l5Cr_Px-nAB28BEf7?(AC75MG9k|dwP4Yq zIHn>+d<82kVnbL>wRr;{qsFicmbSBQ-PvZxgEhDgy2tgPsvQwkzZiwoB_x|4y-Hf^ z15X5jy0G@)755t-uxD56N;@LTx((?_CgN+zOznU7bg2BdX!F@08q5*Ao)p{DYsVeuGxS;k)9BgM#W=^A@ zs`GX75`S{r{O^g%aCZMkF0u|45$Vy;4v!5D&|uw2*<`KsN_V_LI_-m`>=4=zhGYKg zrMJ+bu()4c-QJ0Xsb~|y$N1%oa+QV?o|)gh TZsv1IE>FdOGIbZfdIkUhpy!8N diff --git a/doc/pusb_hotplug.1.gz b/doc/pusb_hotplug.1.gz index 1bd9fe1e81ef1b0dccd569f6cb5addfe1d946645..c1e792391c7893b266ba9a9114300af0467e6339 100644 GIT binary patch delta 584 zcmV-O0=NC%1m6S)ABzYGJuj4z2PA*nG;PybKm!SAMA{G2K*)72iA7>Z{?Qix`kf7> z&@m};B5W$;HcqK*KK0u8ct?*dF;sN~HA9X?xNBkrI%=qjK`rsCK zjq!aOY8b)b1SNJ0v~cw00FDk1KMi0&Up~H^7n1>Fyf}la@#QJIsU~k~Z-#%6i;g0& ziQp2oheqhKMVktX-&fPTI4>C272}oY;CL73rpni+lz%|O? zm99aWjub2%gx+W%QJ}=7l1P8~4y{)d+%sAtBO4kLfNY53`^K73H_saF13`c#?n}{f z#`ByNh|qZ7e_gFsyiZx&*g7kX%m~_(nIfWp*vMNM8+&>iWQ;qY&W%}tH_V|AJ^VWs zPoq!M)MUaeXM7T;A4bUz;I-_mh*&Pru=XJ;VEWXBzb@M`h0Pt(pa_4pBJ1JlFxW&J zVgl@ySc%Yj7g=WLWfmExg~#;$H}K__)r-&UI_P&Mi*Civ3nA}oQd*a9iT>wWunS}E zlakwm4b)ER4)@?}wop3TX6+|&C-Ywg%UcvAg+nrVK~`DpjZK9K`T3o6LbdTmwaR(E z^*?SMcP3bg#H>cH(Pua*npUMNlRaIKBoaNd_Ql)re0DayW@BAi6mSt9AB8Oyd~?#Q We>zoZ{y__W{mzC` z=$I5a^7-!FyZ3B9fH|%`h~P~pypp1AAE8E#R(LF7`3QdPk2;};BmS8mGd@3uKDgyw zV|?F+8b&ZUMTy-KEsTy2;OOx1%K!%S<>RYGF&Qw%i*uNcug=&_HF;NiGlYL!bQFP2 z1Rqd)XoN0Xw5hQ8J)PynMZvhP7_USJC%ZT|RSthBHXJtC_O!cw*-E1;6_3AHs>MyT z6xbR4Cao8~iAf1lHYo4!V(9j{-JE_ZQ8_&;POdNV`NeGd5e4NyX^@SuHG-)C*C>Nm zx&~=FQm}LodZU3vff65-M9P16XuYD~p3xE++0c*xWJ46+H`au@dC_Pe2m&l|e-JHa zJkMEy2#xps*VSsp`;^6vt+Ud|jG#T4DI)r(jl7kyv8T5|#<&CO+?W-3!yNk1!@pzk zH2N$}O(x89#wT(5VU+9u-pbC3h~)weYagQmrcYh?+p--~*uo(Vico(mvL2ofgH5y{ zCcs{al?bhOk!6NnW|3i9cue1a2VZVkz52|qgZ^N$=vM5!6!N|%rFHq9=zp#SyENuL zDY-q^K<%XNa1YLAOQo}I)_xLqviMc7yhTA$I3$yoWR=C<*i@L1U*1V4R2y$ptDNUs z|KrwiXM&YT%xdHseU>+(X;r#1+4BWSBGEHzU%eeK=I66(HrAy@0hi(FN!U`sHz&>d Vr&IN46fe~e_80WTlTj=L003>R9f1G<