[DOCS] [patch] Typo in ECPG Docs

2005-05-09 Thread Andreas Seltenreich
Hi,

I just stumbled across a spurious indefinite article in the ECPG docs.
See the attached patch.

Speaking of indefinite articles, there seems to be some inconsistency
in using "a SQL ..." and "an SQL ..." throughout the docs. This could
probably be easily fixed using a script, but I'm not sure if I'm
missing some grammatical details here, since English isn't my native
language.

regards,
Andreas

Index: ecpg.sgml
===
RCS file: /projects/cvsroot/pgsql/doc/src/sgml/ecpg.sgml,v
retrieving revision 1.63
diff -u -r1.63 ecpg.sgml
--- ecpg.sgml   22 Jan 2005 22:56:35 -  1.63
+++ ecpg.sgml   9 May 2005 03:44:13 -
@@ -446,7 +446,7 @@

 

-The declarations are also echoed to the output file as a normal C
+The declarations are also echoed to the output file as normal C
 variables, so there's no need to declare them again.  Variables
 that are not intended to be used in SQL commands can be declared
 normally outside these special sections.

---(end of broadcast)---
TIP 8: explain analyze is your friend


Re: [DOCS] Using Encryption Patch to Docs

2005-05-09 Thread Bruce Momjian

I have reworded some of the encryption sections in this patch and
applied the changes:


http://candle.pha.pa.us/main/writings/pgsql/sgml/encryption-approaches.html

I moved the section up a few sections, changes the markup a little, and
removed the encryption FAQ item now that we have a clearer encryption
section.

---

pgman wrote:
> 
> Patch applied.  Thanks.  Your documentation changes can be viewed in
> five minutes using links on the developer's page,
> http://www.postgresql.org/developer/testing.
> 
> 
> ---
> 
> 
> Christopher Browne wrote:
> > ? out
> > Index: runtime.sgml
> > ===
> > RCS file: /projects/cvsroot/pgsql/doc/src/sgml/runtime.sgml,v
> > retrieving revision 1.315
> > diff -u -r1.315 runtime.sgml
> > --- runtime.sgml23 Apr 2005 03:27:40 -  1.315
> > +++ runtime.sgml29 Apr 2005 16:43:22 -
> > @@ -5109,6 +5109,132 @@
> >  
> >   
> >  
> > + 
> > +   Use of Encryption in 
> > PostgreSQL
> > +   
> > +encryption
> > +   
> > +
> > +There is increasing interest in having verifiable mechanisms
> > +to maintain the privacy of data in databases.  In the United
> > +States, legislation called HIPAA (Health
> > +Insurance Portability and Accountability Act) requires that
> > +personal health information is handled securely.  The European
> > +Union has similarly been developing directives as to how personal
> > +data is to be managed there.
> > +   
> > +Questions frequently come up as to what functionality
> > +PostgreSQL offers with regard to
> > +supporting the use of data encryption.  It uses and provides use of
> > +encryption tools in several ways that may be useful to provide
> > +protection against certain classes of attacks.
> > +   
> > +   
> > +
> > + Passwords stored in MD5 form 
> > +
> > +  Passwords are normally not stored in
> > +  plaintext form in the database; they are hashed
> > +  using the built-in MD5 function, and that is
> > +  what is stored in the database.  
> > + 
> > +
> > +sample=# alter user foo password 'some dumb value';
> > +ALTER USER
> > +sample=# select usename, passwd from pg_shadow where usename = 'foo';
> > + usename |   passwd
> > +-+-
> > + foo | md5740daa4aaa084d85eb97648084a43bbb
> > +(1 row)
> > +
> > +
> > +
> > +
> > + Connections protected using SSL
> > +
> > +   There are various options to control how mandatory it is
> > +  to use SSL to protect data connections.  At the most
> > +  paranoid end of the spectrum, you can configure
> > +  pg_hba.conf to have the database reject
> > +  connections that do not come in via
> > +  SSL.
> > +
> > +   The use of SSL, alone, is useful for protecting
> > +  communications against interception.  It may not be necessary
> > +  for connections that take place across a carefully controlled
> > +  network; if connections are coming in from less controlled
> > +  sources, its use is highly recommended.
> > +
> > + Connections authenticated using SSL
> > +
> > +  It is possible for both the client and server to provide
> > +  to one another SSL keys or certificates.  It takes some extra
> > +  configuration on each side where these are used, but this likely
> > +  provides stronger verification of identity than the mere use of a
> > +  text password. 
> > +
> > + Using OS level encryption for entire database
> > +  partitions
> > +
> > +  On Linux, encryption can be layered on top of a filesystem
> > +  mount using what is called a loopback device; this
> > +  permits having a whole filesystem partition be encrypted on disk,
> > +  decrypted by the operating system.  On FreeBSD, the equivalent
> > +  facility is called GEOM Based Disk Encryption, or
> > +  gbde.
> > +
> > +  This mechanism may be expected to be useful for protecting
> > +  against the threat that someone might pull disk drives out and
> > +  try to install them somewhere else to draw data off of them.
> > + 
> > +
> > +  In contrast, this mechanism does nothing to protect
> > +  against attacks when the filesystem is mounted, because when
> > +  mounted, the OS provides a view of the filesystem
> > +  accessible in plain text form.  Furthermore, you need some way
> > +  for the encryption key to be passed to the operating system in
> > +  order to mount the filesystems, which encourages having the key
> > +  accessible somewhere on the host that mounts the disk.
> > + 
> > +
> > + Using the contrib function library
> > +  pgcrypto so the database engine manages
> > +  encryption of certain fields.
> > 

Re: [DOCS] Two points about docs

2005-05-09 Thread Bruce Momjian
Vladimir Chukharev wrote:
> On Sun, 08 May 2005 06:18:04 +0300, Bruce Momjian  
> wrote:
> 
> > I have added your first two suggestions.   Not sure where to put the
> > large object links in the function section.  It seems out of place there
> > to me.
> 
> Thanks!
> 
> About the link to the lo_* functions. I thought about adding
> a sentence to Charpter 9 like 'And functions to manipulate large
> objects are presented in Charpter 28.' right after the phrase
> 'Users can also define their own functions and operators, as
> described in Part V.'
> 
> Do you think it's suitable?

Not really.  We don't mention pg_stat_activity functions either.  I
think people have to realize that some functions are covered in other
sections of the manual.  There is a clearly titled section for large
objeccts.

-- 
  Bruce Momjian|  http://candle.pha.pa.us
  [email protected]   |  (610) 359-1001
  +  If your life is a hard drive, |  13 Roberts Road
  +  Christ can be your backup.|  Newtown Square, Pennsylvania 19073

---(end of broadcast)---
TIP 1: subscribe and unsubscribe commands go to [EMAIL PROTECTED]