1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336
|
# coding: utf-8
from datetime import datetime, timedelta
from flask import g, render_template, request, jsonify, make_response
from flask_sqlalchemy import SQLAlchemy
from sqlalchemy.orm import relationship
from flask_oauthlib.provider import OAuth2Provider
from flask_oauthlib.contrib.oauth2 import bind_sqlalchemy
from flask_oauthlib.contrib.oauth2 import bind_cache_grant
db = SQLAlchemy()
class User(db.Model):
id = db.Column(db.Integer, primary_key=True)
username = db.Column(db.String(40), unique=True, index=True,
nullable=False)
def check_password(self, password):
return True
class Client(db.Model):
# id = db.Column(db.Integer, primary_key=True)
# human readable name
name = db.Column(db.String(40))
client_id = db.Column(db.String(40), primary_key=True)
client_secret = db.Column(db.String(55), unique=True, index=True,
nullable=False)
client_type = db.Column(db.String(20), default='public')
_redirect_uris = db.Column(db.Text)
default_scope = db.Column(db.Text, default='email address')
@property
def user(self):
return User.query.get(1)
@property
def redirect_uris(self):
if self._redirect_uris:
return self._redirect_uris.split()
return []
@property
def default_redirect_uri(self):
return self.redirect_uris[0]
@property
def default_scopes(self):
if self.default_scope:
return self.default_scope.split()
return []
@property
def allowed_grant_types(self):
return ['authorization_code', 'password', 'client_credentials',
'refresh_token']
class Grant(db.Model):
id = db.Column(db.Integer, primary_key=True)
user_id = db.Column(
db.Integer, db.ForeignKey('user.id', ondelete='CASCADE')
)
user = relationship('User')
client_id = db.Column(
db.String(40), db.ForeignKey('client.client_id', ondelete='CASCADE'),
nullable=False,
)
client = relationship('Client')
code = db.Column(db.String(255), index=True, nullable=False)
redirect_uri = db.Column(db.String(255))
scope = db.Column(db.Text)
expires = db.Column(db.DateTime)
def delete(self):
db.session.delete(self)
db.session.commit()
return self
@property
def scopes(self):
if self.scope:
return self.scope.split()
return None
class Token(db.Model):
id = db.Column(db.Integer, primary_key=True)
client_id = db.Column(
db.String(40), db.ForeignKey('client.client_id', ondelete='CASCADE'),
nullable=False,
)
user_id = db.Column(
db.Integer, db.ForeignKey('user.id', ondelete='CASCADE')
)
user = relationship('User')
client = relationship('Client')
token_type = db.Column(db.String(40))
access_token = db.Column(db.String(255))
refresh_token = db.Column(db.String(255))
expires = db.Column(db.DateTime)
scope = db.Column(db.Text)
def __init__(self, **kwargs):
expires_in = kwargs.pop('expires_in', None)
if expires_in is not None:
self.expires = datetime.utcnow() + timedelta(seconds=expires_in)
for k, v in kwargs.items():
setattr(self, k, v)
@property
def scopes(self):
if self.scope:
return self.scope.split()
return []
def delete(self):
db.session.delete(self)
db.session.commit()
return self
def current_user():
return g.user
def cache_provider(app):
oauth = OAuth2Provider(app)
bind_sqlalchemy(oauth, db.session, user=User,
token=Token, client=Client)
app.config.update({'OAUTH2_CACHE_TYPE': 'simple'})
bind_cache_grant(app, oauth, current_user)
return oauth
def sqlalchemy_provider(app):
oauth = OAuth2Provider(app)
bind_sqlalchemy(oauth, db.session, user=User, token=Token,
client=Client, grant=Grant, current_user=current_user)
return oauth
def default_provider(app):
oauth = OAuth2Provider(app)
@oauth.clientgetter
def get_client(client_id):
return Client.query.filter_by(client_id=client_id).first()
@oauth.grantgetter
def get_grant(client_id, code):
return Grant.query.filter_by(client_id=client_id, code=code).first()
@oauth.tokengetter
def get_token(access_token=None, refresh_token=None):
if access_token:
return Token.query.filter_by(access_token=access_token).first()
if refresh_token:
return Token.query.filter_by(refresh_token=refresh_token).first()
return None
@oauth.grantsetter
def set_grant(client_id, code, request, *args, **kwargs):
expires = datetime.utcnow() + timedelta(seconds=100)
grant = Grant(
client_id=client_id,
code=code['code'],
redirect_uri=request.redirect_uri,
scope=' '.join(request.scopes),
user_id=g.user.id,
expires=expires,
)
db.session.add(grant)
db.session.commit()
@oauth.tokensetter
def set_token(token, request, *args, **kwargs):
# In real project, a token is unique bound to user and client.
# Which means, you don't need to create a token every time.
tok = Token(**token)
tok.user_id = request.user.id
tok.client_id = request.client.client_id
db.session.add(tok)
db.session.commit()
@oauth.usergetter
def get_user(username, password, *args, **kwargs):
# This is optional, if you don't need password credential
# there is no need to implement this method
return User.query.filter_by(username=username).first()
return oauth
def prepare_app(app):
db.init_app(app)
db.app = app
db.create_all()
client1 = Client(
name='dev', client_id='dev', client_secret='dev',
_redirect_uris=(
'http://localhost:8000/authorized '
'http://localhost/authorized'
),
)
client2 = Client(
name='confidential', client_id='confidential',
client_secret='confidential', client_type='confidential',
_redirect_uris=(
'http://localhost:8000/authorized '
'http://localhost/authorized'
),
)
user = User(username='admin')
temp_grant = Grant(
user_id=1, client_id='confidential',
code='12345', scope='email',
expires=datetime.utcnow() + timedelta(seconds=100)
)
access_token = Token(
user_id=1, client_id='dev', access_token='expired', expires_in=0
)
access_token2 = Token(
user_id=1, client_id='dev', access_token='never_expire'
)
try:
db.session.add(client1)
db.session.add(client2)
db.session.add(user)
db.session.add(temp_grant)
db.session.add(access_token)
db.session.add(access_token2)
db.session.commit()
except:
db.session.rollback()
return app
def create_server(app, oauth=None):
if not oauth:
oauth = default_provider(app)
app = prepare_app(app)
@app.before_request
def load_current_user():
user = User.query.get(1)
g.user = user
@app.route('/home')
def home():
return render_template('home.html')
@app.route('/oauth/authorize', methods=['GET', 'POST'])
@oauth.authorize_handler
def authorize(*args, **kwargs):
# NOTICE: for real project, you need to require login
if request.method == 'GET':
# render a page for user to confirm the authorization
return render_template('confirm.html')
if request.method == 'HEAD':
# if HEAD is supported properly, request parameters like
# client_id should be validated the same way as for 'GET'
response = make_response('', 200)
response.headers['X-Client-ID'] = kwargs.get('client_id')
return response
confirm = request.form.get('confirm', 'no')
return confirm == 'yes'
@app.route('/oauth/token', methods=['POST', 'GET'])
@oauth.token_handler
def access_token():
return {}
@app.route('/oauth/revoke', methods=['POST'])
@oauth.revoke_handler
def revoke_token():
pass
@app.route('/api/email')
@oauth.require_oauth('email')
def email_api():
oauth = request.oauth
return jsonify(email='me@oauth.net', username=oauth.user.username)
@app.route('/api/client')
@oauth.require_oauth()
def client_api():
oauth = request.oauth
return jsonify(client=oauth.client.name)
@app.route('/api/address/<city>')
@oauth.require_oauth('address')
def address_api(city):
oauth = request.oauth
return jsonify(address=city, username=oauth.user.username)
@app.route('/api/method', methods=['GET', 'POST', 'PUT', 'DELETE'])
@oauth.require_oauth()
def method_api():
return jsonify(method=request.method)
@oauth.invalid_response
def require_oauth_invalid(req):
return jsonify(message=req.error_message), 401
return app
if __name__ == '__main__':
from flask import Flask
app = Flask(__name__)
app.debug = True
app.secret_key = 'development'
app.config.update({
'SQLALCHEMY_DATABASE_URI': 'sqlite:///test.sqlite'
})
app = create_server(app)
app.run()
|