<!--
-$PostgreSQL: pgsql/doc/src/sgml/libpq.sgml,v 1.200 2005/12/23 01:16:37 tgl Exp $
+$PostgreSQL: pgsql/doc/src/sgml/libpq.sgml,v 1.201 2005/12/26 14:58:04 petere Exp $
-->
<chapter id="libpq">
<variablelist>
<varlistentry>
-<term><function>pg_make_encrypted_password</function><indexterm><primary>pg_make_encrypted_password</></></term>
+<term><function>PQencryptPassword</function><indexterm><primary>PQencryptPassword</></></term>
<listitem>
<para>
Prepares the encrypted form of a <productname>PostgreSQL</> password.
<synopsis>
-char *pg_make_encrypted_password(const char *passwd, const char *user);
+char * PQencryptPassword(const char *passwd, const char *user);
</synopsis>
-<function>pg_make_encrypted_password</> is intended to be used by client
+This function is intended to be used by client
applications that wish to send commands like
<literal>ALTER USER joe PASSWORD 'pwd'</>.
It is good practice not to send the original cleartext password in such a
and so on. Instead, use this function to convert the password to encrypted
form before it is sent. The arguments are the cleartext password, and the SQL
name of the user it is for. The return value is a malloc'd string, or NULL if
-out-of-memory. The caller may assume the string doesn't contain any weird
+out-of-memory. The caller may assume the string doesn't contain any special
characters that would require escaping. Use <function>PQfreemem</> to free
the result when done with it.
</para>
*
* Copyright (c) 2000-2005, PostgreSQL Global Development Group
*
- * $PostgreSQL: pgsql/src/bin/psql/command.c,v 1.157 2005/12/23 01:16:38 tgl Exp $
+ * $PostgreSQL: pgsql/src/bin/psql/command.c,v 1.158 2005/12/26 14:58:04 petere Exp $
*/
#include "postgres_fe.h"
#include "command.h"
else
user = PQuser(pset.db);
- encrypted_password = pg_make_encrypted_password(pw1, user);
+ encrypted_password = PQencryptPassword(pw1, user);
if (!encrypted_password)
{
* Portions Copyright (c) 1996-2005, PostgreSQL Global Development Group
* Portions Copyright (c) 1994, Regents of the University of California
*
- * $PostgreSQL: pgsql/src/bin/scripts/createuser.c,v 1.25 2005/12/23 01:16:38 tgl Exp $
+ * $PostgreSQL: pgsql/src/bin/scripts/createuser.c,v 1.26 2005/12/26 14:58:05 petere Exp $
*
*-------------------------------------------------------------------------
*/
{
char *encrypted_password;
- encrypted_password = pg_make_encrypted_password(newpassword,
+ encrypted_password = PQencryptPassword(newpassword,
newuser);
if (!encrypted_password)
{
-# $PostgreSQL: pgsql/src/interfaces/libpq/exports.txt,v 1.6 2005/12/23 01:16:38 tgl Exp $
+# $PostgreSQL: pgsql/src/interfaces/libpq/exports.txt,v 1.7 2005/12/26 14:58:05 petere Exp $
# Functions to be exported by libpq DLLs
PQconnectdb 1
PQsetdbLogin 2
lo_create 123
PQinitSSL 124
PQregisterThreadLock 125
-pg_make_encrypted_password 126
+PQencryptPassword 126
* exceed INITIAL_EXPBUFFER_SIZE (currently 256 bytes).
*
* IDENTIFICATION
- * $PostgreSQL: pgsql/src/interfaces/libpq/fe-auth.c,v 1.109 2005/12/23 01:16:38 tgl Exp $
+ * $PostgreSQL: pgsql/src/interfaces/libpq/fe-auth.c,v 1.110 2005/12/26 14:58:05 petere Exp $
*
*-------------------------------------------------------------------------
*/
/*
- * pg_make_encrypted_password -- exported routine to encrypt a password
+ * PQencryptPassword -- exported routine to encrypt a password
*
* This is intended to be used by client applications that wish to send
* commands like ALTER USER joe PASSWORD 'pwd'. The password need not
* is for.
*
* Return value is a malloc'd string, or NULL if out-of-memory. The client
- * may assume the string doesn't contain any weird characters that would
+ * may assume the string doesn't contain any special characters that would
* require escaping.
*/
char *
-pg_make_encrypted_password(const char *passwd, const char *user)
+PQencryptPassword(const char *passwd, const char *user)
{
char *crypt_pwd;
* Portions Copyright (c) 1996-2005, PostgreSQL Global Development Group
* Portions Copyright (c) 1994, Regents of the University of California
*
- * $PostgreSQL: pgsql/src/interfaces/libpq/libpq-fe.h,v 1.123 2005/12/23 01:16:38 tgl Exp $
+ * $PostgreSQL: pgsql/src/interfaces/libpq/libpq-fe.h,v 1.124 2005/12/26 14:58:06 petere Exp $
*
*-------------------------------------------------------------------------
*/
/* === in fe-auth.c === */
-extern char *pg_make_encrypted_password(const char *passwd, const char *user);
+extern char *PQencryptPassword(const char *passwd, const char *user);
#ifdef __cplusplus
}