| 1 |
<?php
|
| 2 |
//$Header: /hl/cvsroots/gpl01/gpl01/webprojs/pamc/gen_a/sw/phplib/ref_tables/db_design.inc,v 1.6 2007/07/01 03:06:21 dashley Exp $
|
| 3 |
//--------------------------------------------------------------------------------
|
| 4 |
//db_design.inc -- PAMC MySQL database design reference information. This is used
|
| 5 |
// to create the database, to access the database, and to print
|
| 6 |
// human-readable information about the design of the database.
|
| 7 |
//Copyright (C) 2007 David T. Ashley
|
| 8 |
//--------------------------------------------------------------------------------
|
| 9 |
//This program is free software; you can redistribute it and/or
|
| 10 |
//modify it under the terms of the GNU General Public License
|
| 11 |
//as published by the Free Software Foundation; either version 2
|
| 12 |
//of the License, or (at your option) any later version.
|
| 13 |
//
|
| 14 |
//This program is distributed in the hope that it will be useful,
|
| 15 |
//but WITHOUT ANY WARRANTY; without even the implied warranty of
|
| 16 |
//MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
| 17 |
//GNU General Public License for more details.
|
| 18 |
//
|
| 19 |
//You should have received a copy of the GNU General Public License
|
| 20 |
//along with this program; if not, write to the Free Software
|
| 21 |
//Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
| 22 |
//--------------------------------------------------------------------------------
|
| 23 |
//Author contact information:
|
| 24 |
// David T. Ashley
|
| 25 |
// P.O. Box 918
|
| 26 |
// Marshall, Michigan, 49068
|
| 27 |
// dta@e3ft.com
|
| 28 |
//--------------------------------------------------------------------------------
|
| 29 |
$config_hard['dbdesign']['detailed'] =
|
| 30 |
array
|
| 31 |
(
|
| 32 |
array
|
| 33 |
(
|
| 34 |
'name' => 'tokens',
|
| 35 |
'desc_short' => 'Cryptographic Tokens',
|
| 36 |
'desc_long' => 'Each record in this table is an individual cryptographic ' .
|
| 37 |
'token (Cryptocard\'s KT-1 keychain token, for example).',
|
| 38 |
'fields' => array
|
| 39 |
(
|
| 40 |
array
|
| 41 |
(
|
| 42 |
'name' => 'idx',
|
| 43 |
'type' => 'int',
|
| 44 |
'dimension' => 0,
|
| 45 |
'primarykey' => TRUE,
|
| 46 |
'autoincrement' => TRUE,
|
| 47 |
'index' => FALSE,
|
| 48 |
'indexprefixlength' => 0,
|
| 49 |
'desc_short' => 'Integer Index',
|
| 50 |
'desc_long' => 'Automatically-assigned integer index of token.'
|
| 51 |
),
|
| 52 |
array
|
| 53 |
(
|
| 54 |
'name' => 'manufacturer',
|
| 55 |
'type' => 'varchar',
|
| 56 |
'dimension' => 100,
|
| 57 |
'primarykey' => FALSE,
|
| 58 |
'autoincrement' => FALSE,
|
| 59 |
'index' => FALSE,
|
| 60 |
'indexprefixlength' => 0,
|
| 61 |
'desc_short' => 'Token Manufacturer',
|
| 62 |
'desc_long' => 'Company that manufactured the cryptographic token.'
|
| 63 |
),
|
| 64 |
array
|
| 65 |
(
|
| 66 |
'name' => 'modelnumber',
|
| 67 |
'type' => 'varchar',
|
| 68 |
'dimension' => 100,
|
| 69 |
'primarykey' => FALSE,
|
| 70 |
'autoincrement' => FALSE,
|
| 71 |
'index' => FALSE,
|
| 72 |
'indexprefixlength' => 0,
|
| 73 |
'desc_short' => 'Model Number',
|
| 74 |
'desc_long' => 'Model number of token.'
|
| 75 |
),
|
| 76 |
array
|
| 77 |
(
|
| 78 |
'name' => 'serialnumber',
|
| 79 |
'type' => 'varchar',
|
| 80 |
'dimension' => 100,
|
| 81 |
'primarykey' => FALSE,
|
| 82 |
'autoincrement' => FALSE,
|
| 83 |
'index' => FALSE,
|
| 84 |
'indexprefixlength' => 0,
|
| 85 |
'desc_short' => 'Serial Number',
|
| 86 |
'desc_long' => 'Serial number of token as assigned by manufacturer.'
|
| 87 |
),
|
| 88 |
array
|
| 89 |
(
|
| 90 |
'name' => 'tokenkey',
|
| 91 |
'type' => 'varchar',
|
| 92 |
'dimension' => 255,
|
| 93 |
'primarykey' => FALSE,
|
| 94 |
'autoincrement' => FALSE,
|
| 95 |
'index' => FALSE,
|
| 96 |
'indexprefixlength' => 0,
|
| 97 |
'desc_short' => 'Key',
|
| 98 |
'desc_long' => 'Cryptographic key with which token is programmed. (This is ' .
|
| 99 |
'normally a secret known only to the token to the server which must authenticate ' .
|
| 100 |
'the token.)'
|
| 101 |
),
|
| 102 |
array
|
| 103 |
(
|
| 104 |
'name' => 'options',
|
| 105 |
'type' => 'varchar',
|
| 106 |
'dimension' => 100,
|
| 107 |
'primarykey' => FALSE,
|
| 108 |
'autoincrement' => FALSE,
|
| 109 |
'index' => FALSE,
|
| 110 |
'indexprefixlength' => 0,
|
| 111 |
'desc_short' => 'Options',
|
| 112 |
'desc_long' => 'Token options. Currently, this field is not used. In the future, more ' .
|
| 113 |
'flexible support for Cryptocard tokens in particular may be added'
|
| 114 |
)
|
| 115 |
)
|
| 116 |
),
|
| 117 |
array
|
| 118 |
(
|
| 119 |
'name' => 'logentries',
|
| 120 |
'desc_short' => 'Log Entries',
|
| 121 |
'desc_long' => 'Each record in this table is a log entry. The system log holds information about system events ' .
|
| 122 |
'and can be sorted and reviewed.',
|
| 123 |
'fields' => array
|
| 124 |
(
|
| 125 |
array
|
| 126 |
(
|
| 127 |
'name' => 'idx',
|
| 128 |
'type' => 'bigint',
|
| 129 |
'dimension' => 0,
|
| 130 |
'primarykey' => TRUE,
|
| 131 |
'autoincrement' => TRUE,
|
| 132 |
'index' => FALSE,
|
| 133 |
'indexprefixlength' => 0,
|
| 134 |
'desc_short' => 'Integer Index',
|
| 135 |
'desc_long' => 'Automatically-assigned integer index of the log entry.'
|
| 136 |
)
|
| 137 |
)
|
| 138 |
),
|
| 139 |
array
|
| 140 |
(
|
| 141 |
'name' => 'users',
|
| 142 |
'desc_short' => 'Users',
|
| 143 |
'desc_long' => 'Each record in this table is an user who can log in ' .
|
| 144 |
'to the PAMC system.',
|
| 145 |
'fields' => array
|
| 146 |
(
|
| 147 |
array
|
| 148 |
(
|
| 149 |
'name' => 'idx',
|
| 150 |
'type' => 'int',
|
| 151 |
'dimension' => 0,
|
| 152 |
'primarykey' => TRUE,
|
| 153 |
'autoincrement' => TRUE,
|
| 154 |
'index' => FALSE,
|
| 155 |
'indexprefixlength' => 0,
|
| 156 |
'desc_short' => 'Integer Index',
|
| 157 |
'desc_long' => 'Automatically-assigned integer index of the user record.'
|
| 158 |
),
|
| 159 |
array
|
| 160 |
(
|
| 161 |
'name' => 'userid',
|
| 162 |
'type' => 'varchar',
|
| 163 |
'dimension' => 20,
|
| 164 |
'primarykey' => FALSE,
|
| 165 |
'autoincrement' => FALSE,
|
| 166 |
'index' => TRUE,
|
| 167 |
'indexprefixlength' => 0,
|
| 168 |
'desc_short' => 'Userid',
|
| 169 |
'desc_long' => 'Login name of the user.'
|
| 170 |
),
|
| 171 |
array
|
| 172 |
(
|
| 173 |
'name' => 'pwhash',
|
| 174 |
'type' => 'varchar',
|
| 175 |
'dimension' => 40,
|
| 176 |
'primarykey' => FALSE,
|
| 177 |
'autoincrement' => FALSE,
|
| 178 |
'index' => FALSE,
|
| 179 |
'indexprefixlength' => 0,
|
| 180 |
'desc_short' => 'Password Hash (SHA1)',
|
| 181 |
'desc_long' => 'Password hash of the user\'s password. This is the system hash function ' .
|
| 182 |
'of the user\'s password (SHA1, with the system hash key concatenated).'
|
| 183 |
),
|
| 184 |
array
|
| 185 |
(
|
| 186 |
'name' => 'lname',
|
| 187 |
'type' => 'varchar',
|
| 188 |
'dimension' => 25,
|
| 189 |
'primarykey' => FALSE,
|
| 190 |
'autoincrement' => FALSE,
|
| 191 |
'index' => TRUE,
|
| 192 |
'indexprefixlength' => 0,
|
| 193 |
'desc_short' => 'Last Name',
|
| 194 |
'desc_long' => 'Last name of the user. May not be empty.'
|
| 195 |
),
|
| 196 |
array
|
| 197 |
(
|
| 198 |
'name' => 'fname',
|
| 199 |
'type' => 'varchar',
|
| 200 |
'dimension' => 25,
|
| 201 |
'primarykey' => FALSE,
|
| 202 |
'autoincrement' => FALSE,
|
| 203 |
'index' => FALSE,
|
| 204 |
'indexprefixlength' => 0,
|
| 205 |
'desc_short' => 'First Name',
|
| 206 |
'desc_long' => 'First name of the user. May not be empty.'
|
| 207 |
),
|
| 208 |
array
|
| 209 |
(
|
| 210 |
'name' => 'mnameinitial',
|
| 211 |
'type' => 'varchar',
|
| 212 |
'dimension' => 25,
|
| 213 |
'primarykey' => FALSE,
|
| 214 |
'autoincrement' => FALSE,
|
| 215 |
'index' => FALSE,
|
| 216 |
'indexprefixlength' => 0,
|
| 217 |
'desc_short' => 'Middle Name or Initial',
|
| 218 |
'desc_long' => 'Middle name or initial of the user. If the column is an initial, it must ' .
|
| 219 |
'be in upper-case, with a \'.\' appended. May be empty.'
|
| 220 |
),
|
| 221 |
array
|
| 222 |
(
|
| 223 |
'name' => 'salutationshort',
|
| 224 |
'type' => 'varchar',
|
| 225 |
'dimension' => 100,
|
| 226 |
'primarykey' => FALSE,
|
| 227 |
'autoincrement' => FALSE,
|
| 228 |
'index' => FALSE,
|
| 229 |
'indexprefixlength' => 0,
|
| 230 |
'desc_short' => 'Salutation (Short)',
|
| 231 |
'desc_long' => 'The short salutation used to address the user ' .
|
| 232 |
'(example: \'John\' in \'Good morning, John\'). ' .
|
| 233 |
'May not be empty. Specified separately rather than automatically calculated ' .
|
| 234 |
'because of individual and international variability.'
|
| 235 |
),
|
| 236 |
array
|
| 237 |
(
|
| 238 |
'name' => 'salutationlong',
|
| 239 |
'type' => 'varchar',
|
| 240 |
'dimension' => 100,
|
| 241 |
'primarykey' => FALSE,
|
| 242 |
'autoincrement' => FALSE,
|
| 243 |
'index' => FALSE,
|
| 244 |
'indexprefixlength' => 0,
|
| 245 |
'desc_short' => 'Salutation (Long)',
|
| 246 |
'desc_long' => 'The long salutation used to address the user ' .
|
| 247 |
'(example: \'John J. Smith\' in \'You are logged in as John J. Smith\'). ' .
|
| 248 |
'May not be empty. Specified separately rather than automatically calculated ' .
|
| 249 |
'because of individual and international variability.'
|
| 250 |
)
|
| 251 |
)
|
| 252 |
)
|
| 253 |
);
|
| 254 |
//--------------------------------------------------------------------------------
|
| 255 |
//End of $RCSfile: db_design.inc,v $.
|
| 256 |
//--------------------------------------------------------------------------------
|
| 257 |
?>
|
Parent Directory
| 
Revision Log