Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
O
OpnSense
Project
Project
Details
Activity
Releases
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
Kulya
OpnSense
Commits
c4354331
Commit
c4354331
authored
Nov 10, 2015
by
Ad Schellevis
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
(mvc) add api auth to base controller
parent
b096c21e
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
58 additions
and
17 deletions
+58
-17
ApiControllerBase.php
...e/mvc/app/controllers/OPNsense/Base/ApiControllerBase.php
+58
-17
No files found.
src/opnsense/mvc/app/controllers/OPNsense/Base/ApiControllerBase.php
View file @
c4354331
...
@@ -28,6 +28,8 @@
...
@@ -28,6 +28,8 @@
*/
*/
namespace
OPNsense\Base
;
namespace
OPNsense\Base
;
use
OPNsense\Core\ACL
;
use
OPNsense\Auth\AuthenticationFactory
;
/**
/**
* Class ApiControllerBase, inherit this class to implement API calls
* Class ApiControllerBase, inherit this class to implement API calls
* @package OPNsense\Base
* @package OPNsense\Base
...
@@ -66,28 +68,67 @@ class ApiControllerBase extends ControllerRoot
...
@@ -66,28 +68,67 @@ class ApiControllerBase extends ControllerRoot
*/
*/
public
function
beforeExecuteRoute
(
$dispatcher
)
public
function
beforeExecuteRoute
(
$dispatcher
)
{
{
// TODO: implement authentication for api calls, at this moment you need a valid session on the web interface
// handle authentication / authorization
if
(
!
empty
(
$this
->
request
->
getHeader
(
'Authorization'
)))
{
// Authorization header send, handle API request
$authHeader
=
explode
(
' '
,
$this
->
request
->
getHeader
(
'Authorization'
));
if
(
count
(
$authHeader
)
>
1
)
{
$key_secret_hash
=
$authHeader
[
1
];
$key_secret
=
explode
(
':'
,
base64_decode
(
$key_secret_hash
));
if
(
count
(
$key_secret
)
>
1
)
{
$apiKey
=
$key_secret
[
0
];
$apiSecret
=
$key_secret
[
1
];
// use authentication of legacy OPNsense to validate user.
$authFactory
=
new
AuthenticationFactory
;
if
(
!
$this
->
doAuth
())
{
$authenticator
=
$authFactory
->
get
(
"Local API"
);
if
(
$authenticator
->
authenticate
(
$apiKey
,
$apiSecret
))
{
$authResult
=
$authenticator
->
getLastAuthProperties
();
if
(
array_key_exists
(
'username'
,
$authResult
))
{
$acl
=
new
ACL
();
if
(
!
$acl
->
isPageAccessible
(
$authResult
[
'username'
],
$_SERVER
[
'REQUEST_URI'
]))
{
$this
->
getLogger
()
->
error
(
"uri "
.
$_SERVER
[
'REQUEST_URI'
]
.
" not accessible for user "
.
$authResult
[
'username'
]
.
" using api key "
.
$apiKey
);
}
else
{
// authentication + authorization successful, pass
return
true
;
}
}
}
}
}
// not authenticated
$this
->
response
->
setStatusCode
(
401
,
"Unauthorized"
);
$this
->
response
->
setContentType
(
'application/json'
,
'UTF-8'
);
$this
->
response
->
setJsonContent
(
array
(
'status'
=>
401
,
'message'
=>
'Authentication Failed'
,
));
$this
->
response
->
send
();
return
false
;
return
false
;
}
}
else
{
// handle UI ajax reuests
// use authentication of legacy OPNsense to validate user.
if
(
!
$this
->
doAuth
())
{
return
false
;
}
// check for valid csrf on post requests
// check for valid csrf on post requests
$csrf_tokenkey
=
$this
->
request
->
getHeader
(
'X_CSRFTOKENKEY'
);
$csrf_tokenkey
=
$this
->
request
->
getHeader
(
'X_CSRFTOKENKEY'
);
$csrf_token
=
$this
->
request
->
getHeader
(
'X_CSRFTOKEN'
);
$csrf_token
=
$this
->
request
->
getHeader
(
'X_CSRFTOKEN'
);
$csrf_valid
=
$this
->
security
->
checkToken
(
$csrf_tokenkey
,
$csrf_token
,
false
);
$csrf_valid
=
$this
->
security
->
checkToken
(
$csrf_tokenkey
,
$csrf_token
,
false
);
if
((
$this
->
request
->
isPost
()
||
if
((
$this
->
request
->
isPost
()
||
$this
->
request
->
isPut
()
||
$this
->
request
->
isPut
()
||
$this
->
request
->
isDelete
()
$this
->
request
->
isDelete
()
)
&&
!
$csrf_valid
)
&&
!
$csrf_valid
)
{
)
{
// missing csrf, exit.
// missing csrf, exit.
$this
->
getLogger
()
->
error
(
"no matching csrf found for request"
);
$this
->
getLogger
()
->
error
(
"no matching csrf found for request"
);
return
false
;
return
false
;
}
}
}
}
}
/**
/**
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment